{
    "$id": "http://redfish.dmtf.org/schemas/swordfish/v1/FileSystem.v1_4_2.json",
    "$ref": "#/definitions/FileSystem",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2015-2026 Storage Networking Industry Association (SNIA), USA. All rights reserved.",
    "definitions": {
        "Actions": {
            "additionalProperties": false,
            "description": "The available actions for this resource.",
            "longDescription": "This type shall contain the available actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "Oem": {
                    "$ref": "#/definitions/OemActions",
                    "description": "This property contains the available OEM specific actions for this resource.",
                    "longDescription": "This property shall contain any additional OEM actions for this resource.",
                    "versionAdded": "v1_1_0"
                }
            },
            "type": "object"
        },
        "CharacterCodeSet": {
            "description": "Supported character code standards for different alphabets and languages.",
            "enum": [
                "ASCII",
                "Unicode",
                "ISO2022",
                "ISO8859_1",
                "ExtendedUNIXCode",
                "UTF_8",
                "UTF_16",
                "UCS_2"
            ],
            "enumDescriptions": {
                "ASCII": "ASCII character encoding.",
                "ExtendedUNIXCode": "Extended Unix Code encoding.",
                "ISO2022": "ISO-2022 character encoding.",
                "ISO8859_1": "ISO-8859-1 character encoding.",
                "UCS_2": "UCS-2 character encoding.",
                "UTF_16": "UTF-16 character encoding.",
                "UTF_8": "UTF-8 character encoding.",
                "Unicode": "Unicode character encoding."
            },
            "enumLongDescriptions": {
                "ASCII": "This value shall indicate that the ASCII character encoding is supported by the file system.",
                "ExtendedUNIXCode": "This value shall indicate that Extended Unix Code character encoding is supported by the file system.",
                "ISO2022": "This value shall indicate that ISO-2022 character encoding is supported by the file system.",
                "ISO8859_1": "This value shall indicate that ISO-8859-1 character encoding is supported by the file system.",
                "UCS_2": "This value shall indicate that the UCS-2 character encoding is supported by the file system.",
                "UTF_16": "This value shall indicate that the UTF-16 character encoding is supported by the file system.",
                "UTF_8": "This value shall indicate that the UTF-8 character encoding is supported by the file system.",
                "Unicode": "This value shall indicate that Unicode character encoding is supported by the file system."
            },
            "longDescription": "The values shall indicate the character code standards supported by the file system.",
            "type": "string"
        },
        "FileSystem": {
            "additionalProperties": false,
            "description": "An instance of a hierarchical namespace of files.",
            "longDescription": "This resource shall be used to represent an instance of a hierarchical namespace of files.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
                },
                "@odata.etag": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
                },
                "AccessCapabilities": {
                    "description": "An array of supported IO access capabilities.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/DataStorageLoSCapabilities.json#/definitions/StorageAccessCapability"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall be an array containing entries for the supported IO access capabilities. Each entry shall specify a current storage access capability.",
                    "readonly": false,
                    "type": "array"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "The Actions property shall contain the available actions for this resource.",
                    "versionAdded": "v1_1_0"
                },
                "BlockSizeBytes": {
                    "description": "Block size of the file system in bytes.",
                    "longDescription": "The value of this property shall be the block size of the file system in bytes.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "Capacity": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Capacity.json#/definitions/Capacity",
                    "description": "Capacity allocated to the file system.",
                    "longDescription": "The value of this property shall be the capacity allocated to the file system in bytes."
                },
                "CapacitySources": {
                    "description": "An array of capacity sources for the file system.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Capacity.json#/definitions/CapacitySource"
                    },
                    "longDescription": "This property shall be an array containing entries for all the capacity sources for the file system. Each entry shall provide capacity allocation information from a named resource.",
                    "readonly": false,
                    "type": "array"
                },
                "CapacitySources@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "CasePreserved": {
                    "description": "The case of file names is preserved by the file system.",
                    "longDescription": "This property shall indicate that the case of file names is preserved by the file system. A value of True shall indicate that case of file names shall be preserved.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "CaseSensitive": {
                    "description": "Case sensitive file names are supported by the file system.",
                    "longDescription": "This property shall indicate that case sensitive file names are supported by the file system. A value of True shall indicate that file names are case sensitive.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "CharacterCodeSet": {
                    "description": "An array of the character sets or encodings supported by the file system.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/CharacterCodeSet"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall be an array containing entries for the character sets or encodings supported by the file system. Each entry shall specify a character set encoding supported by the file system.",
                    "readonly": false,
                    "type": "array"
                },
                "ClusterSizeBytes": {
                    "description": "A value indicating the minimum file allocation size imposed by the file system.",
                    "longDescription": "This value shall specify the minimum file allocation size imposed by the file system. This minimum allocation size shall be the smallest amount of storage allocated to a file by the file system. Under stress conditions, the file system may allocate storage in amounts smaller than this value.",
                    "minimum": 1,
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "ExportedShares": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/FileShareCollection.json#/definitions/FileShareCollection",
                    "description": "An array of exported file shares of this file system.",
                    "longDescription": "This property shall be an array of exported file shares of this file system. Each entry shall define an exported file share of this file system.",
                    "readonly": false
                },
                "IOStatistics": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/IOStatistics.json#/definitions/IOStatistics",
                    "deprecated": "This property is deprecated in favor of the IOStatistics property in FileSystemMetrics.",
                    "description": "Statistics for this FileSystem.",
                    "longDescription": "The value shall represent IO statistics for this FileSystem.",
                    "versionAdded": "v1_2_0",
                    "versionDeprecated": "v1_4_0"
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "Identifiers": {
                    "description": "The durable names for this file system.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier"
                    },
                    "longDescription": "This property shall contain a list of all known durable names for this file system.",
                    "type": "array",
                    "versionAdded": "v1_1_1"
                },
                "ImportedShares": {
                    "description": "An array of imported file shares.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/FileSystem.json#/definitions/ImportedShare"
                    },
                    "longDescription": "The value shall be an array of imported file shares.",
                    "type": "array",
                    "versionAdded": "v1_0_1"
                },
                "Links": {
                    "$ref": "#/definitions/Links",
                    "description": "Contains links to other resources that are related to this resource.",
                    "longDescription": "This property shall contain links to other resources that are related to this resource."
                },
                "LowSpaceWarningThresholdPercents": {
                    "description": "An array of low space warning threshold percentages for the file system.",
                    "items": {
                        "type": [
                            "integer",
                            "null"
                        ]
                    },
                    "longDescription": "This property shall be an array containing entries for the percentages of file system capacity at which low space warning events are be issued. A LOW_SPACE_THRESHOLD_WARNING event shall be triggered each time the remaining file system capacity value becomes less than one of the values in the array. The following shall be true: Across all CapacitySources entries, percent = (SUM(AllocatedBytes) - SUM(ConsumedBytes))/SUM(AllocatedBytes).",
                    "maximum": 100,
                    "minimum": 0,
                    "readonly": false,
                    "type": "array",
                    "units": "%"
                },
                "MaxFileNameLengthBytes": {
                    "description": "A value indicating the maximum length of a file name within the file system.",
                    "longDescription": "If specified, this value shall specify the maximum length of a file name within the file system.",
                    "minimum": 1,
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By"
                },
                "Metrics": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/FileSystemMetrics.json#/definitions/FileSystemMetrics"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The link to the metrics for this file system.",
                    "longDescription": "This property shall contain a link to a resource of type FileSystemMetrics that specifies the metrics for this file system. IO metrics are reported in the IOStatistics property.",
                    "readonly": true,
                    "versionAdded": "v1_4_0"
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
                },
                "RecoverableCapacitySourceCount": {
                    "description": "Current number of capacity source resources that are available as replacements.",
                    "longDescription": "The value is the number of available capacity source resources currently available in the event that an equivalent capacity source resource fails.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_2_0"
                },
                "RemainingCapacity": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/Capacity.json#/definitions/Capacity",
                    "deprecated": "This property is deprecated in favor of the Capacity property.  The RemainingCapacity can be computed from the values of that property, for each of the sub groups xxx: Data, MetaData, and Snapshot.  The RemainingCapacity is xxx/ProvisionedBytes - xxx/ConsumedBytes.",
                    "description": "Remaining capacity allocated to the file system.",
                    "longDescription": "The value of this property shall be the remaining capacity allocated to the file system in bytes."
                },
                "RemainingCapacityPercent": {
                    "description": "The percentage of the capacity remaining in the FileSystem.",
                    "longDescription": "If present, this value shall return  {[(SUM(AllocatedBytes) - SUM(ConsumedBytes)]/SUM(AllocatedBytes)}*100 represented as an integer value.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "versionAdded": "v1_1_0"
                },
                "ReplicaInfo": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/StorageReplicaInfo.json#/definitions/ReplicaInfo",
                    "description": "This value describes the replica attributes if this file system is a replica.",
                    "longDescription": "If this file system is a replica, this value shall describe its replication attributes. This value shall not be present if this file system is not a replica. A file system may be both a source and a replica."
                },
                "ReplicaTargets": {
                    "description": "The resources that are target replicas of this source.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
                    },
                    "longDescription": "The value shall reference the target replicas that are sourced by this replica.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_2_1"
                },
                "ReplicaTargets@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "ReplicationEnabled": {
                    "description": "Indicates whether or not replication is enabled on the file system.",
                    "longDescription": "The property shall indicate whether or not replication is enabled on the file system. This property shall be consistent with the state reflected at the storage pool level.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_3_0"
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "Links": {
            "additionalProperties": false,
            "description": "Contains links to other resources that are related to this resource.",
            "longDescription": "This property shall contain links to other resources that are related to this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "ClassOfService": {
                    "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/ClassOfService.json#/definitions/ClassOfService",
                    "description": "The ClassOfService of this file system.",
                    "longDescription": "This value shall be a link to the ClassOfService for this file system.",
                    "readonly": true
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
                },
                "ReplicaCollection": {
                    "deprecated": "Deprecated in favor of ReplicaTargets.",
                    "description": "An array of links to replicas for this file system.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/FileSystem.json#/definitions/FileSystem"
                    },
                    "longDescription": "This property shall be an array of links to replicas for this file system. Each entry shall be a link to a replica for this file system.",
                    "readonly": true,
                    "type": "array"
                },
                "ReplicaCollection@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "SpareResourceSets": {
                    "description": "An array of references to SpareResourceSets.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/SpareResourceSet.json#/definitions/SpareResourceSet"
                    },
                    "longDescription": "Each referenced SpareResourceSet shall contain resources that may be utilized to replace the capacity provided by a failed resource having a compatible type.",
                    "readonly": false,
                    "type": "array",
                    "versionAdded": "v1_2_0"
                },
                "SpareResourceSets@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                }
            },
            "type": "object"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM specific actions for this resource.",
            "longDescription": "This type shall contain any additional OEM actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {},
            "type": "object"
        }
    },
    "language": "en",
    "owningEntity": "SNIA",
    "release": "1.2.6",
    "title": "#FileSystem.v1_4_2.FileSystem"
}