# Class CIM_FSQuotaManagementService
extends CIM_Service

The QuotaConfigurationService performs all modifications and queries to the state of a running or stopped quota system, including the FSQuotaConfigEntries that determine the thresholds and entities being monitored.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_Service
|
+--CIM_FSQuotaManagementService

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | The QuotaConfigurationService performs all modifications and queries to the state of a running or stopped quota system, including the FSQuotaConfigEntries that determine the thresholds and entities being monitored.
Experimental | boolean | true
UMLPackagePath | string | CIM::System::FileServices
Version | string | 2.43.0

## Class Properties

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_Service
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
LoSID | string | CIM_Service
LoSOrgID | string | CIM_Service
Name | string | CIM_Service
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryOwnerContact | string | CIM_Service
PrimaryOwnerName | string | CIM_Service
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Started | boolean | CIM_Service
StartMode | string | CIM_Service
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_Service
SystemName | string | CIM_Service
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### FindQuotaEntries (uint32)

#### Method Qualifiers (FindQuotaEntries)

Name | Data Type | Value
--- | --- | ---
Description | string | Method to get quota entries that match a given principal, tree, quota type and resource type on a given CS. Any or none of these may be specified, meaning that any or none of them may be NULL. If none are specified, the routine is equivalent to EnumerateInstances(); this is not recommended if an entry contains multiple principals.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, .., 65536..
Values | string | Success, None found, Bad identity, Bad element, Bad tree, Bad resource type, Bad quota type, Reserved, Vendor Defined

#### Method Parameters (FindQuotaEntries)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
IdentityId | string
Description | string | An FSDomainIdentity InstanceID.
IN | boolean | true
ModelCorrespondence | string | CIM_FSDomainIdentity.InstanceID
QuotaType | uint16
Description | string | The type of quota to find. A value of 0 (Unknown) here will return entries matching any type.
IN | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, .., 0x8000..
Values | string | Unknown, Other, User, Group, Tree, User-tree, Group-tree, Reserved, Vendor Defined
Tree | string
Description | string | A tree name. This MUST be an absolute path.
IN | boolean | true
QuotaEntries | string[]
Description | string | The quota entries in embedded instance form. If no quota entries matching the specified input arguments can be found, this parameter MUST be NULL.
EmbeddedInstance | string | CIM_FSQuotaConfigEntry
OUT | boolean | true
ElementId | REF CIM_ComputerSystem
Description | string | Reference to the file server containing the quota entries. This entry MUST NOT be NULL.
IN | boolean | true

#### DeleteQuotaEntry (uint32)

#### Method Qualifiers (DeleteQuotaEntry)

Name | Data Type | Value
--- | --- | ---
Description | string | Method to delete a quota entry with a given InstanceID. Return values are described in the valuemap array. In the case of a malformed entry, an error with more information may also be thrown. NOTE: Deleting a quota entry does not destroy the CIM Instance. Call DeleteInstance() to do this.
Experimental | boolean | true
ValueMap | string | 0, 1, .., 65536..
Values | string | Success, InstanceID not found, Reserved, Vendor Defined

#### Method Parameters (DeleteQuotaEntry)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
EntryID | string
Description | string | The InstanceID of the quota entry to delete.
IN | boolean | true
ModelCorrespondence | string | CIM_FSQuotaConfigEntry.InstanceID

#### ModifyQuotaEntry (uint32)

#### Method Qualifiers (ModifyQuotaEntry)

Name | Data Type | Value
--- | --- | ---
Description | string | Method to modify a quota entry with a given InstanceID. It is illegal to modify the instance ID, tree, principal, resource type, quota type or managed element of a quota entry, and clients MUST NOT attempt this. All other fields may be modified. Depending on the system, doing so may take some time, and a job MAY be created for tracking progress.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, .., 65536..
Values | string | Success, InstanceID not found, Malformed entry, Reserved, Vendor Defined

#### Method Parameters (ModifyQuotaEntry)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
EntryId | string
Description | string | The InstanceID of the quota entry to modify.
IN | boolean | true
ModelCorrespondence | string | CIM_FSQuotaConfigEntry.InstanceID
QuotaEntry | string
Description | string | The modified quota entry in embedded instance form.
EmbeddedInstance | string | CIM_FSQuotaConfigEntry
IN | boolean | true
Job | REF CIM_Job
Description | string | A job tracking progress of the method. If no job is created, this property MUST be NULL.
OUT | boolean | true

#### AddQuotaEntry (uint32)

#### Method Qualifiers (AddQuotaEntry)

Name | Data Type | Value
--- | --- | ---
Description | string | Method to add a quota entry. It is an error to specify an InstanceID in the proposed new entry. Return values are described in the valuemap array. In the case of a malformed entry, an error with more information may also be thrown. Some systems will reject duplicate entries; others may not. What happens in the case of duplicate keys is determined by the setting of the ConflictingEntriesUsage property of the FSQuotaCapabilities associated with the system instance this call is being made against.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, .., 65536..
Values | string | Success, InstanceID specified, Duplicate key, Malformed entry, Reserved, Vendor Defined

#### Method Parameters (AddQuotaEntry)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
QuotaEntry | string
Description | string | The quota entry to add, in embedded instance form.
EmbeddedInstance | string | CIM_FSQuotaConfigEntry
IN | boolean | true
Job | REF CIM_Job
Description | string | A job tracking progress of the method. If no job is created, this property MUST be NULL.
OUT | boolean | true

#### GetQuotaReport (uint32)

#### Method Qualifiers (GetQuotaReport)

Name | Data Type | Value
--- | --- | ---
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, .., 65536..
Values | string | Success, Bad cursor, Tree parameter unsupported, User parameter unsupported, Group parameter unsupported, ManagedElement parameter unsupported, Tree not found, User not found, Group not found, ManagedElement not found, No more data, Reserved, Vendor Defined

#### Method Parameters (GetQuotaReport)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Cursor | string
Description | string | A cursor for use in chunking up the quota report. Initial calls to begin a report MUST pass NULL for the cursor. After that, each successive call for records from the same report MUST pass back the same cursor that was returned for the previous call. Note, however, that clients which wish to depend on other flow control mechanisms may simply pass (uint64)(-1) in the NQuotas parameter, and all records will be returned in one chunk.
IN | boolean | true
OUT | boolean | true
Group | string
Description | string | The group to report on. If this is NULL, there is no restriction on users in the report. If a given group is not known to the system, the routine MUST return 8 (Group not found). If the instrumentation is unable to support the given group as an input to the quota reporting subsystem, the routine MUST return 4 (Group param unsupported). Otherwise quota statistics are reported for objects in the given group only.
EmbeddedInstance | string | CIM_FSDomainIdentity
IN | boolean | true
NRecords | uint64
Description | string | A number describing the number of quota records desired in one chunk, when passed in, and the number actually returned, when passed back out. A recommended chunk size is 100 to 1000. Clients which wish to depend on other flow control mechanisms instead of the chunking mechanism provided here should pass (uint64)(-1) for this parameter.
IN | boolean | true
OUT | boolean | true
Tree | string
Description | string | The tree to report on. If this is NULL, the report will be over the entire Element. If the given path is not on the system, the routine MUST return 6 (Tree not found). If the instrumentation is unable to support the given path as an input to the quota reporting subsystem, the routine MUST return 2 (Tree param unsupported). Otherwise quota statistics are reported for objects in the given tree only.
IN | boolean | true
User | string
Description | string | The user to report on. If this is NULL, there is no restriction on users in the report. If a given user is not known to the system, the routine MUST return 7 (User not found). If the instrumentation is unable to support the given user as an input to the quota reporting subsystem, the routine MUST return 3 (User param unsupported). Otherwise quota statistics are reported for the given user only.
EmbeddedInstance | string | CIM_FSDomainIdentity
IN | boolean | true
ReportRecs | string[]
Description | string | The quota report records.
EmbeddedInstance | string | CIM_FSQuotaReportRecord
OUT | boolean | true
Element | REF CIM_ManagedElement
Description | string | The ME to report on. This could be a ComputerSystem or StorageExtent (Filesystem). The instrumentation MUST start at the most specific type and work its way up the type hierarchy while attempting to identify the element in question. If reporting on a found element is not supported, the routine MUST return 5 (ME param not supported). If no element pertaining to a supported quota report configuration can be found, the routine MUST return 9 (ME not found).
IN | boolean | true
Job | REF CIM_Job
Description | string | It's possible that initiating a quota report may take some time, before any records at all are available for viewing. Instrumentation that supports jobs may return a job in this case, along with a return code of 0 (Success). If no job is created, the provider MUST return NULL for this parameter.
OUT | boolean | true

#### EnableQuotas (uint32)

#### Method Qualifiers (EnableQuotas)

Name | Data Type | Value
--- | --- | ---
Description | string | Turn quota statistics gathering and reporting on or off. If turning quotas on and off for the given managed element type is unsupported, the system MUST return 1 (Operation unsupported for this ME type). Secondarily, if the system does not support turning quotas on or off for individual managed elements of the given type, the system MUST return 2 (Operation unsupported for individual MEs of this type).
Experimental | boolean | true
ValueMap | string | 0, 1, 2, .., 65536..
Values | string | Success, Operation unsupported for this ME type, Operation unsupported for individual MEs of this type, Reserved, Vendor Defined

#### Method Parameters (EnableQuotas)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
OnOff | boolean
Description | string | Whether to turn quotas on or off.
IN | boolean | true
Element | REF CIM_ManagedElement
Description | string | The managed element on which to turn quotas on or off.
IN | boolean | true
Job | REF CIM_Job
Description | string | It's possible that changing the state of the system may take some time. Instrumentation that supports jobs may return a job in this case, along with a return code of 0 (Success). If no job is created, the provider MUST return NULL for this parameter.
OUT | boolean | true

#### InitializeQuotas (uint32)

#### Method Qualifiers (InitializeQuotas)

Name | Data Type | Value
--- | --- | ---
Experimental | boolean | true
ValueMap | string | 0, 1, 2, .., 65536..
Values | string | Success, Error, Unsupported, Reserved, Vendor Defined

#### Method Parameters (InitializeQuotas)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Job | REF CIM_Job
Description | string | It's possible that changing the state of the system may take some time. Instrumentation that supports jobs may return a job in this case, along with a return code of 0 (Success). If no job is created, the provider MUST return NULL for this parameter.
OUT | boolean | true

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
ChangeAffectedElementsAssignedSequence | uint32 | CIM_Service
RequestStateChange | uint32 | CIM_EnabledLogicalElement
StartService | uint32 | CIM_Service
StopService | uint32 | CIM_Service