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

NameData TypeValue
DescriptionstringThe 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.
UMLPackagePathstringCIM::System::FileServices
Versionstring2.45.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

FindQuotaEntries (uint32)

Method Qualifiers (FindQuotaEntries)

NameData TypeValue
DescriptionstringMethod 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 65536..
ValuesstringSuccess, None found, Bad identity, Bad element, Bad tree, Bad resource type, Bad quota type, Reserved, Vendor Defined

Method Parameters (FindQuotaEntries)

NameTypeQualifiers
NameData TypeValue
IdentityIdstring
DescriptionstringAn FSDomainIdentity InstanceID.
ModelCorrespondencestringCIM_FSDomainIdentity.InstanceID
QuotaTypeuint16
DescriptionstringThe type of quota to find. A value of 0 (Unknown) here will return entries matching any type.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x8000..
ValuesstringUnknown, Other, User, Group, Tree, User-tree, Group-tree, Reserved, Vendor Defined
Treestring
DescriptionstringA tree name. This MUST be an absolute path.
QuotaEntriesstring[]
DescriptionstringThe quota entries in embedded instance form. If no quota entries matching the specified input arguments can be found, this parameter MUST be NULL.
EmbeddedInstancestringCIM_FSQuotaConfigEntry
OUTbooleantrue
ElementId REF CIM_ComputerSystem
DescriptionstringReference to the file server containing the quota entries. This entry MUST NOT be NULL.

DeleteQuotaEntry (uint32)

Method Qualifiers (DeleteQuotaEntry)

NameData TypeValue
DescriptionstringMethod 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.
ValueMapstring0, 1, .., 65536..
ValuesstringSuccess, InstanceID not found, Reserved, Vendor Defined

Method Parameters (DeleteQuotaEntry)

NameTypeQualifiers
NameData TypeValue
EntryIDstring
DescriptionstringThe InstanceID of the quota entry to delete.
ModelCorrespondencestringCIM_FSQuotaConfigEntry.InstanceID

ModifyQuotaEntry (uint32)

Method Qualifiers (ModifyQuotaEntry)

NameData TypeValue
DescriptionstringMethod 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.
ValueMapstring0, 1, 2, .., 65536..
ValuesstringSuccess, InstanceID not found, Malformed entry, Reserved, Vendor Defined

Method Parameters (ModifyQuotaEntry)

NameTypeQualifiers
NameData TypeValue
EntryIdstring
DescriptionstringThe InstanceID of the quota entry to modify.
ModelCorrespondencestringCIM_FSQuotaConfigEntry.InstanceID
QuotaEntrystring
DescriptionstringThe modified quota entry in embedded instance form.
EmbeddedInstancestringCIM_FSQuotaConfigEntry
Job REF CIM_Job
DescriptionstringA job tracking progress of the method. If no job is created, this property MUST be NULL.
OUTbooleantrue

AddQuotaEntry (uint32)

Method Qualifiers (AddQuotaEntry)

NameData TypeValue
DescriptionstringMethod 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.
ValueMapstring0, 1, 2, 3, .., 65536..
ValuesstringSuccess, InstanceID specified, Duplicate key, Malformed entry, Reserved, Vendor Defined

Method Parameters (AddQuotaEntry)

NameTypeQualifiers
NameData TypeValue
QuotaEntrystring
DescriptionstringThe quota entry to add, in embedded instance form.
EmbeddedInstancestringCIM_FSQuotaConfigEntry
Job REF CIM_Job
DescriptionstringA job tracking progress of the method. If no job is created, this property MUST be NULL.
OUTbooleantrue

GetQuotaReport (uint32)

Method Qualifiers (GetQuotaReport)

NameData TypeValue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, .., 65536..
ValuesstringSuccess, 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)

NameTypeQualifiers
NameData TypeValue
Cursorstring
DescriptionstringA 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.
OUTbooleantrue
Groupstring
DescriptionstringThe 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.
EmbeddedInstancestringCIM_FSDomainIdentity
NRecordsuint64
DescriptionstringA 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.
OUTbooleantrue
Treestring
DescriptionstringThe 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.
Userstring
DescriptionstringThe 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.
EmbeddedInstancestringCIM_FSDomainIdentity
ReportRecsstring[]
DescriptionstringThe quota report records.
EmbeddedInstancestringCIM_FSQuotaReportRecord
OUTbooleantrue
Element REF CIM_ManagedElement
DescriptionstringThe 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).
Job REF CIM_Job
DescriptionstringIt'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.
OUTbooleantrue

EnableQuotas (uint32)

Method Qualifiers (EnableQuotas)

NameData TypeValue
DescriptionstringTurn 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).
ValueMapstring0, 1, 2, .., 65536..
ValuesstringSuccess, Operation unsupported for this ME type, Operation unsupported for individual MEs of this type, Reserved, Vendor Defined

Method Parameters (EnableQuotas)

NameTypeQualifiers
NameData TypeValue
OnOffboolean
DescriptionstringWhether to turn quotas on or off.
Element REF CIM_ManagedElement
DescriptionstringThe managed element on which to turn quotas on or off.
Job REF CIM_Job
DescriptionstringIt'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.
OUTbooleantrue

InitializeQuotas (uint32)

Method Qualifiers (InitializeQuotas)

NameData TypeValue
ValueMapstring0, 1, 2, .., 65536..
ValuesstringSuccess, Error, Unsupported, Reserved, Vendor Defined

Method Parameters (InitializeQuotas)

NameTypeQualifiers
NameData TypeValue
Job REF CIM_Job
DescriptionstringIt'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.
OUTbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service