Class AMT_ThirdPartyDataStorageAdministrationService
Used in
features: Storage
Compatible with the following Intel AMT
Releases: 3.0, 3.2, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5,
10.0, 11.0
CIM_ManagedElement
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_Service
AMT_ThirdPartyDataStorageAdministrationService
class AMT_ThirdPartyDataStorageAdministrationService
- extends CIM_Service
General Information:
The Storage Administration service enables
administrators to reconfigure the global parameters that govern allocation and
use of third-party non-volatile storage. It also enables to retrieve various
management data, and perform management
actions.
Qualifiers:
-------------
Version=4.0.0
Supported Fields
Summary |
string
|
Name The Name property uniquely identifies the
Service and provides an indication of the functionality that is managed .
. .
|
string
|
CreationClassName CreationClassName indicates the name
of the class or the subclass that is used in the creation of an instance .
. .
|
string
|
SystemName The Name of the scoping System.
|
string
|
SystemCreationClassName The CreationClassName of the scoping
System.
|
string
|
ElementName A
user-friendly name for the object . . .
|
uint16[]
|
OperationalStatus
Indicates the current statuses of the element . . .
|
uint16
|
EnabledState
EnabledState is an integer enumeration that indicates the
enabled and disabled states of an element . . .
|
uint16
|
RequestedState
RequestedState is an integer enumeration that indicates the
last requested or desired state for the element, irrespective of the
mechanism through which it was requested . . .
|
uint16
|
EnabledDefault
An enumerated value indicating an administrator's default or
startup configuration for the Enabled State of an element . .
.
|
Methods Summary |
uint32 |
GetGlobalStorageAttributes(TotalStorage,
TotalAllocatedStorage, MaxPartnerStorage, TotalPartnerAllocatedStorage,
MaxNonPartnerStorage, MaxFpaclEntries, MaxAslEntries, MaxEaclEntries,
MaxGroupsPerBlock, MaxMembersPerGroup,
MaxNonPartnerTotalAllocationSize) Get the global attributes of
the third party storage system in the Intel(R) AMT device.
|
uint32 |
SetGlobalStorageAttributes(MaxPartnerStorage,
MaxNonPartnerTotalAllocationSize) Set global attributes of the
third party storage system in the Intel(R) AMT device.
|
uint32 |
AdminGetRegisteredApplications(ApplicationHandles)
Returns a list of handles, each associated with a storage application
which has registered to the Intel(R) AMT device in the past (i.e . .
.
|
uint32 |
AdminGetApplicationAttributes(Handle,
AttrType, UUID, VendorName, ApplicationName, EnterpriseName,
CurrentAllocationSize, ActiveSession, Partner) Get attributes
of a third party application from the Intel(R) AMT device.
|
uint32 |
AdminRemoveApplication(Handle)
Releases all Intel(R) AMT resources associated with a single ISV
application . . .
|
uint32 |
AddStorageEaclEntry(EnterpriseName,
Handle) Adds a new ISV Storage Enterprise Access Control List
(EACL) entry and returns a handle that can be used in subsequent ISV
Storage operations.
|
uint32 |
EnumerateStorageEaclEntries(Handles)
Returns a list of ISV Storage Enterprise Access Control List (EACL)
entry handles that can be used in subsequent ISV Storage
operations.
|
uint32 |
GetStorageEaclEntry(Handle,
EnterpriseName) Returns a single ISV Storage Enterprise Access
Control List (EACL) entry, given a handle returned by AddStorageEaclEntry
or EnumerateStorageEaclEntries.
|
uint32 |
RemoveStorageEaclEntry(Handle)
Removes a single ISV Storage Enterprise Access Control List (EACL)
entry, given a handle returned by AddStorageEaclEntry or
EnumerateStorageEaclEntries . . .
|
uint32 |
AddStorageFpaclEntry(AttrType,
ApplicationName, VendorName, IsPartner, TotalAllocationSize,
Handle) Adds an entry to the ISV Storage Factory Partner
Allocation Control List (FPACL) . . .
|
uint32 |
EnumerateStorageAllocEntries(Handles)
Enumerates entries in the ISV Storage Factory Partner Allocation
Control List (FPACL) and in the non-partner Allocation Control
List.
|
uint32 |
GetStorageAllocEntry(Handle,
AttrType, ApplicationName, VendorName, IsPartner,
TotalAllocationSize) Returns a single ISV Storage Factory
Partner Allocation Control List (FPACL) or non-partner Allocation Control
List (NACL) entry, given the entry's handle . . .
|
uint32 |
UpdateStorageFpaclEntry(Handle,
NewAllocationSize) Updates the allocation size of an existing
entry in the ISV Storage Factory Partner Allocation Control List (FPACL),
given the entry's handle and the new size . . .
|
uint32 |
RemoveStorageFpaclEntry(Handle)
This function removes an entry from the ISV Storage Factory Partner
Allocation Control List (FPACL), given the entry's handle . . .
|
|
Get(Instance) Gets the
representation of the instance
|
|
Pull(EnumerationContext,
MaxElements) Pulls instances of this class, following an
Enumerate operation
|
|
Enumerate()
Enumerates the instances of this class
|
|
Release(EnumerationContext)
Releases an enumeration context
|
Name
public string Name
- General Information:
The Name property uniquely identifies the
Service and provides an indication of the functionality that is managed. This
functionality is described in more detail in the Description property of the
object.
Product Specific Usage:
In Intel AMT Release 6.0 and
later releases value is 'Intel(r) AMT Third Party Data Storage Administration
Service'
Qualifiers:
-------------
Key
Override=Name
MaxLen=65
CreationClassName
public string CreationClassName
- General Information:
CreationClassName indicates the name of the
class or the subclass that is used in the creation of an instance. When used
with the other key properties of this class, this property allows all
instances of this class and its subclasses to be uniquely
identified.
Product Specific Usage:
In Intel AMT Release 6.0
and later releases value is
'AMT_ThirdPartyDataStorageAdministrationService'
Qualifiers:
-------------
Key
MaxLen=50
SystemName
public string SystemName
- General Information:
The Name of the scoping
System.
Product Specific Usage:
In Intel AMT Release 6.0 and
later releases value is 'Intel(r)
AMT'
Qualifiers:
-------------
Key
MaxLen=256
Propagated=CIM_System.Name
SystemCreationClassName
public string SystemCreationClassName
- General Information:
The CreationClassName of the scoping
System.
Product Specific Usage:
In Intel AMT Release 6.0 and
later releases value is
'CIM_ComputerSystem'
Qualifiers:
-------------
Key
MaxLen=20
Propagated=CIM_System.CreationClassName
ElementName
public string ElementName
- General Information:
A user-friendly name for the object. This
property allows each instance to define a user-friendly name in addition to
its key properties, identity data, and description information.
Note that
the Name property of ManagedSystemElement is also defined as a user-friendly
name. But, it is often subclassed to be a Key. It is not reasonable that the
same property can convey both identity and a user-friendly name, without
inconsistencies. Where Name exists and is not a Key (such as for instances of
LogicalDevice), the same information can be present in both the Name and
ElementName properties. Note that if there is an associated instance of
CIM_EnabledLogicalElementCapabilities, restrictions on this properties may
exist as defined in ElementNameMask and MaxElementNameLen properties defined
in that class.
Product Specific Usage:
In Intel AMT Release
6.0 and later releases value is 'Intel(r) AMT Third Party Data Storage
Administration
Service'
Qualifiers:
-------------
MaxLen=65
OperationalStatus
public uint16[] OperationalStatus
- General Information:
Indicates the current statuses of the
element. Various operational statuses are defined. Many of the enumeration's
values are self-explanatory. However, a few are not and are described here in
more detail.
"Stressed" indicates that the element is functioning, but
needs attention. Examples of "Stressed" states are overload, overheated, and
so on.
"Predictive Failure" indicates that an element is functioning
nominally but predicting a failure in the near future.
"In Service"
describes an element being configured, maintained, cleaned, or otherwise
administered.
"No Contact" indicates that the monitoring system has
knowledge of this element, but has never been able to establish communications
with it.
"Lost Communication" indicates that the ManagedSystem Element is
known to exist and has been contacted successfully in the past, but is
currently unreachable.
"Stopped" and "Aborted" are similar, although the
former implies a clean and orderly stop, while the latter implies an abrupt
stop where the state and configuration of the element might need to be
updated.
"Dormant" indicates that the element is inactive or quiesced.
"Supporting Entity in Error" indicates that this element might be "OK" but
that another element, on which it is dependent, is in error. An example is a
network service or endpoint that cannot function due to lower-layer networking
problems.
"Completed" indicates that the element has completed its
operation. This value should be combined with either OK, Error, or Degraded so
that a client can tell if the complete operation Completed with OK (passed),
Completed with Error (failed), or Completed with Degraded (the operation
finished, but it did not complete OK or did not report an error).
"Power
Mode" indicates that the element has additional power model information
contained in the Associated PowerManagementService association.
"Relocating" indicates the element is being
relocated.
OperationalStatus replaces the Status property on
ManagedSystemElement to provide a consistent approach to enumerations, to
address implementation needs for an array property, and to provide a migration
path from today's environment to the future. This change was not made earlier
because it required the deprecated qualifier. Due to the widespread use of the
existing Status property in management applications, it is strongly
recommended that providers or instrumentation provide both the Status and
OperationalStatus properties. Further, the first value of OperationalStatus
should contain the primary status for the element. When instrumented, Status
(because it is single-valued) should also provide the primary status of the
element.
Qualifiers:
-------------
ValueMap={0, 1, 2, 3,
4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ..,
0x8000..}
Values={Unknown, Other, OK, Degraded, Stressed, Predictive
Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In
Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity
in Error, Completed, Power Mode, Relocating, DMTF Reserved, Vendor
Reserved}
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.StatusDescriptions}
EnabledState
public uint16 EnabledState
- General Information:
EnabledState is an integer enumeration that
indicates the enabled and disabled states of an element. It can also indicate
the transitions between these requested states. For example, shutting down
(value=4) and starting (value=10) are transient states between enabled and
disabled. The following text briefly summarizes the various enabled and
disabled states:
Enabled (2) indicates that the element is or could be
executing commands, will process any queued commands, and queues new requests.
Disabled (3) indicates that the element will not execute commands and will
drop any new requests.
Shutting Down (4) indicates that the element is in
the process of going to a Disabled state.
Not Applicable (5) indicates the
element does not support being enabled or disabled.
Enabled but Offline
(6) indicates that the element might be completing commands, and will drop any
new requests.
Test (7) indicates that the element is in a test state.
Deferred (8) indicates that the element might be completing commands, but
will queue any new requests.
Quiesce (9) indicates that the element is
enabled but in a restricted mode.
Starting (10) indicates that the element
is in the process of going to an Enabled state. New requests are
queued.
Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4,
5, 6, 7, 8, 9, 10, 11..32767, 32768..65535}
Values={Unknown, Other,
Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In
Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor
Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.OtherEnabledState}
RequestedState
public uint16 RequestedState
- General Information:
RequestedState is an integer enumeration
that indicates the last requested or desired state for the element,
irrespective of the mechanism through which it was requested. The actual state
of the element is represented by EnabledState. This property is provided to
compare the last requested and current enabled or disabled states. Note that
when EnabledState is set to 5 ("Not Applicable"), then this property has no
meaning. Refer to the EnabledState property description for explanations of
the values in the RequestedState enumeration.
"Unknown" (0) indicates the
last requested state for the element is unknown.
Note that the value "No
Change" (5) has been deprecated in lieu of indicating the last requested state
is "Unknown" (0). If the last requested or desired state is unknown,
RequestedState should have the value "Unknown" (0), but may have the value "No
Change" (5).Offline (6) indicates that the element has been requested to
transition to the Enabled but Offline EnabledState.
It should be noted
that there are two new values in RequestedState that build on the statuses of
EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing
a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the
element is first "Disabled" and then "Enabled". The distinction between
requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests
an orderly transition to the Disabled state, and might involve removing power,
to completely erase any existing state. The Disabled state requests an
immediate disabling of the element, such that it will not execute or accept
any commands or processing requests.
This property is set as the
result of a method invocation (such as Start or StopService on CIM_Service),
or can be overridden and defined as WRITEable in a subclass. The method
approach is considered superior to a WRITEable property, because it allows an
explicit invocation of the operation and the return of a result code.
If knowledge of the last RequestedState is not supported for the
EnabledLogicalElement, the property shall be NULL or have the value 12 "Not
Applicable".
Qualifiers:
-------------
ValueMap={0, 2, 3,
4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535}
Values={Unknown, Enabled,
Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot,
Reset, Not Applicable, DMTF Reserved, Vendor
Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}
EnabledDefault
public uint16 EnabledDefault
- General Information:
An enumerated value indicating an
administrator's default or startup configuration for the Enabled State of an
element. By default, the element is "Enabled"
(value=2).
Qualifiers:
-------------
Write
ValueMap={2,
3, 5, 6, 7, 9, .., 32768..65535}
Values={Enabled, Disabled, Not Applicable,
Enabled but Offline, No Default, Quiesce, DMTF Reserved, Vendor
Reserved}
GetGlobalStorageAttributes
public uint32 GetGlobalStorageAttributes([OUT]uint32 TotalStorage, [OUT]uint32 TotalAllocatedStorage, [OUT]uint32 MaxPartnerStorage, [OUT]uint32 TotalPartnerAllocatedStorage, [OUT]uint32 MaxNonPartnerStorage, [OUT]uint16 MaxFpaclEntries, [OUT]uint16 MaxAslEntries, [OUT]uint16 MaxEaclEntries, [OUT]uint16 MaxGroupsPerBlock, [OUT]uint16 MaxMembersPerGroup, [OUT]uint32 MaxNonPartnerTotalAllocationSize)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General Information:
Get
the global attributes of the third party storage system in the Intel(R) AMT
device.
Qualifiers:
-------------
ValueMap={0,
1}
Values={PT_STATUS_SUCCESS,
PT_STATUS_INTERNAL_ERROR}
Parameters:
--------------
- TotalStorage
- General Information:
Specifies the total size, in bytes, of
the portion of non-volatile memory that is available to third-party
applications. This total is subdivided into partner and non-partner
areas.
Qualifiers:
-------------
OUT
- TotalAllocatedStorage
- General Information:
Specifies the total size, in bytes, of
the portion of third-party application storage which is already allocated
for use by
applications.
Qualifiers:
-------------
OUT
- MaxPartnerStorage
- General Information:
Specifies the size, in bytes, of the
portion of third-party non-volatile storage that is reserved for partner
applications. This size is specified as a number of bytes. The sum of
MaxPartnerStorage and MaxNonPartnerStorage must not exceed the total size of
third-party non-volatile storage. The total size of non-volatile storage is
an implementation-dependent quantity, but shall not be less than 96
kilobytes.
Qualifiers:
-------------
OUT
- TotalPartnerAllocatedStorage
- General Information:
Specifies the size, in bytes, of the
portion of third-party partner application storage which is allocated for
use by
applications.
Qualifiers:
-------------
OUT
- MaxNonPartnerStorage
- General Information:
Specifies the total size, in bytes, of
the portion of third-party non-volatile storage that is available for
non-partner applications. This area is also open to partner applications
when partner storage becomes unavailable. This size is specified as a number
of bytes. The sum of MaxPartnerStorage and MaxNonPartnerStorage must not
exceed the total size of third-party non-volatile storage. The total size of
non-volatile storage is an implementation-dependent quantity, but shall not
be less than 96
kilobytes.
Qualifiers:
-------------
OUT
- MaxFpaclEntries
- General Information:
Specifies the maximum number of entries
supported in the Factory Partner Allocation Control List (FPACL). This is
also the maximum number of different partner applications supported by the
Intel(R) AMT device at one
time.
Qualifiers:
-------------
OUT
- MaxAslEntries
- General Information:
Specifies the maximum number of entries
supported in the Application Session List (ASL). This is the maximum number
of application sessions supported concurrently at the same
time.
Qualifiers:
-------------
OUT
- MaxEaclEntries
- General Information:
Specifies the maximum number of entries
in the Enterprise access control list
(EACL).
Qualifiers:
-------------
OUT
- MaxGroupsPerBlock
- General Information:
Specifies the maximum number of
permissions groups that may be associated with a single block of storage.
Every permissions group is associated with a single block of
storage.
Qualifiers:
-------------
OUT
- MaxMembersPerGroup
- General Information:
Specifies the maximum number of members
that any permissions group may
have.
Qualifiers:
-------------
OUT
- MaxNonPartnerTotalAllocationSize
- General Information:
The maximum total allocation size, in
bytes, for a single non-partner storage
application.
Qualifiers:
-------------
OUT
SetGlobalStorageAttributes
public uint32 SetGlobalStorageAttributes([IN]uint32 MaxPartnerStorage, [IN]uint32 MaxNonPartnerTotalAllocationSize)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General Information:
Set
global attributes of the third party storage system in the Intel(R) AMT
device.
Qualifiers:
-------------
ValueMap={0, 1, 36, 38,
2075}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR,
PT_STATUS_INVALID_PARAMETER, PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED,
PT_STATUS_AUDIT_FAIL}
Parameters:
--------------
- MaxPartnerStorage
- General Information:
Specifies a new value for the size of the
portion of third-party non-volatile storage that is reserved for partner
applications. This size is specified as a number of bytes. The remaining
portion of third-party non-volatile storage is used for non-partner
applications. The total size of non-volatile storage is an
implementation-dependent quantity, but shall not be less than 96 kilobytes.
The size must be a multiple of
4KB.
Qualifiers:
-------------
IN
- MaxNonPartnerTotalAllocationSize
- General Information:
Specifies the maximum total number of
bytes that can be allocated by any application that is not in the Factory
Partner Allocation Control List. The size must be a multiple of
4KB.
Qualifiers:
-------------
IN
AdminGetRegisteredApplications
public uint32 AdminGetRegisteredApplications([OUT]uint32 ApplicationHandles[128])
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General
Information:
Returns a list of handles, each associated with a storage
application which has registered to the Intel(R) AMT device in the past (i.e.
in the ARL list).
Qualifiers:
-------------
ValueMap={0,
1}
Values={PT_STATUS_SUCCESS,
PT_STATUS_INTERNAL_ERROR}
Parameters:
--------------
- ApplicationHandles
- General Information:
The list of the application
handles.
Qualifiers:
-------------
OUT
AdminGetApplicationAttributes
public uint32 AdminGetApplicationAttributes([IN]uint32 Handle, [OUT]uint32 AttrType, [OUT]uint8 UUID[16], [OUT]string VendorName, [OUT]string ApplicationName, [OUT]string EnterpriseName, [OUT]uint32 CurrentAllocationSize, [OUT]boolean ActiveSession, [OUT]boolean Partner)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General Information:
Get
attributes of a third party application from the Intel(R) AMT
device.
Qualifiers:
-------------
ValueMap={0, 1,
2053}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR,
PT_STATUS_INVALID_HANDLE}
Parameters:
--------------
- Handle
- General Information:
Handle of the application whose
attributes are being
requested.
Qualifiers:
-------------
Required
IN
- AttrType
- General Information:
The type of application attributes in
this entry. This parameter should always return a value of
1.
Qualifiers:
-------------
OUT
- UUID
- General Information:
Unique identifier of this application.
This should be the 16-byte SMBIOS UUID value of the machine from which the
registration
originated.
Qualifiers:
-------------
OUT
Octetstring
- VendorName
- General Information:
The name of the vendor as specified by
the vendor and provided in the application's
registration.
Qualifiers:
-------------
OUT
MaxLen=64
- ApplicationName
- General Information:
The name of the ISV application, as
specified by the vendor and provided in the application's
registration.
Qualifiers:
-------------
OUT
MaxLen=64
- EnterpriseName
- General Information:
The name of the enterprise that acquires
and owns the Intel(R) AMT system, as specified by the enterprise and
provided in the application's
registration.
Qualifiers:
-------------
OUT
MaxLen=64
- CurrentAllocationSize
- General Information:
The number of bytes of storage currently
allocated by the
application.
Qualifiers:
-------------
OUT
- ActiveSession
- General Information:
Set to TRUE if Intel(R) AMT has active
session state for the application; otherwise this field is set to
FALSE.
Qualifiers:
-------------
OUT
- Partner
- General Information:
Set to TRUE if the application is in the
Factory Partner Allocation List (FPACL), otherwise this field is set to
FALSE.
Qualifiers:
-------------
OUT
AdminRemoveApplication
public uint32 AdminRemoveApplication([IN]uint32 Handle)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General
Information:
Releases all Intel(R) AMT resources associated with a
single ISV application. If the application owns any storage blocks, then they
are released, along with any associated permissions group resources. The
application is removed from all permissions groups associated with storage
blocks that are owned by another
application.
Qualifiers:
-------------
ValueMap={0, 1,
2053}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR,
PT_STATUS_INVALID_HANDLE}
Parameters:
--------------
- Handle
- General Information:
Handle of the application being
removed.
Qualifiers:
-------------
Required
IN
AddStorageEaclEntry
public uint32 AddStorageEaclEntry([IN]string EnterpriseName, [OUT]uint32 Handle)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General Information:
Adds
a new ISV Storage Enterprise Access Control List (EACL) entry and returns a
handle that can be used in subsequent ISV Storage
operations.
Qualifiers:
-------------
ValueMap={0, 1, 12,
23, 38, 2058, 2075}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR,
PT_STATUS_INVALID_NAME, PT_STATUS_MAX_LIMIT_REACHED,
PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED, PT_STATUS_DUPLICATE,
PT_STATUS_AUDIT_FAIL}
Parameters:
--------------
- EnterpriseName
- General Information:
An EACL entry to be added to the
list.
Qualifiers:
-------------
Required
IN
MaxLen=64
- Handle
- General Information:
The handle to the added EACL
entry.
Qualifiers:
-------------
OUT
EnumerateStorageEaclEntries
public uint32 EnumerateStorageEaclEntries([OUT]uint32 Handles[4])
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General
Information:
Returns a list of ISV Storage Enterprise Access Control
List (EACL) entry handles that can be used in subsequent ISV Storage
operations.
Qualifiers:
-------------
ValueMap={0,
1}
Values={PT_STATUS_SUCCESS,
PT_STATUS_INTERNAL_ERROR}
Parameters:
--------------
- Handles
- General Information:
The list of the EACL entries
handles.
Qualifiers:
-------------
OUT
GetStorageEaclEntry
public uint32 GetStorageEaclEntry([IN]uint32 Handle, [OUT]string EnterpriseName)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General
Information:
Returns a single ISV Storage Enterprise Access Control
List (EACL) entry, given a handle returned by AddStorageEaclEntry or
EnumerateStorageEaclEntries.
Qualifiers:
-------------
ValueMap={0,
1, 2053}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR,
PT_STATUS_INVALID_HANDLE}
Parameters:
--------------
- Handle
- General Information:
Contains a handle to one of the EACL
entries.
Qualifiers:
-------------
Required
IN
- EnterpriseName
- General Information:
The requested EACL
entry.
Qualifiers:
-------------
OUT
MaxLen=64
RemoveStorageEaclEntry
public uint32 RemoveStorageEaclEntry([IN]uint32 Handle)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General
Information:
Removes a single ISV Storage Enterprise Access Control
List (EACL) entry, given a handle returned by AddStorageEaclEntry or
EnumerateStorageEaclEntries. If an application using this Enterprise ACL entry
has registered, then this operation will fail. The applications using the
entry must be removed before the entry itself can be
removed.
Qualifiers:
-------------
ValueMap={0, 1, 2053,
2056, 2075}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR,
PT_STATUS_INVALID_HANDLE, PT_STATUS_STORAGE_ACL_ENTRY_IN_USE,
PT_STATUS_AUDIT_FAIL}
Parameters:
--------------
- Handle
- General Information:
Contains a handle to one of the EACL
entries.
Qualifiers:
-------------
Required
IN
AddStorageFpaclEntry
public uint32 AddStorageFpaclEntry([IN]uint32 AttrType, [IN]string ApplicationName, [IN]string VendorName, [IN]boolean IsPartner, [IN]uint32 TotalAllocationSize, [OUT]uint32 Handle)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General Information:
Adds
an entry to the ISV Storage Factory Partner Allocation Control List (FPACL).
Non-partner allocation control list (NACL) entries cannot be added using this
method. NACL entries are added when a non-partner application registers for
the first time.
Qualifiers:
-------------
ValueMap={0, 1,
12, 15, 23, 36, 38, 2058, 2075}
Values={PT_STATUS_SUCCESS,
PT_STATUS_INTERNAL_ERROR, PT_STATUS_INVALID_NAME,
PT_STATUS_INVALID_BYTE_COUNT, PT_STATUS_MAX_LIMIT_REACHED,
PT_STATUS_INVALID_PARAMETER, PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED,
PT_STATUS_DUPLICATE,
PT_STATUS_AUDIT_FAIL}
Parameters:
--------------
- AttrType
- General Information:
The type of application attributes in
this entry. This parameter should always have a value of
1.
Qualifiers:
-------------
Required
IN
- ApplicationName
- General Information:
Name of an ISV storage
application.
Qualifiers:
-------------
Required
IN
MaxLen=64
- VendorName
- General Information:
Name of the ISV
vendor.
Qualifiers:
-------------
Required
IN
MaxLen=64
- IsPartner
- General Information:
This parameter should always have a value
of TRUE, which indicates a partner
application.
Qualifiers:
-------------
Required
IN
- TotalAllocationSize
- General Information:
Maximum size, in bytes, of storage area
an application of this type can allocate. Must be a multiple of
4KB.
Qualifiers:
-------------
Required
IN
- Handle
- General Information:
FPACL entry
handle.
Qualifiers:
-------------
OUT
EnumerateStorageAllocEntries
public uint32 EnumerateStorageAllocEntries([OUT]uint32 Handles[48])
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General
Information:
Enumerates entries in the ISV Storage Factory Partner
Allocation Control List (FPACL) and in the non-partner Allocation Control
List.
Qualifiers:
-------------
ValueMap={0,
1}
Values={PT_STATUS_SUCCESS,
PT_STATUS_INTERNAL_ERROR}
Parameters:
--------------
- Handles
- General Information:
Contains a list of FPACL or NACL entries
handles.
Qualifiers:
-------------
OUT
GetStorageAllocEntry
public uint32 GetStorageAllocEntry([IN]uint32 Handle, [OUT]uint32 AttrType, [OUT]string ApplicationName, [OUT]string VendorName, [OUT]boolean IsPartner, [OUT]uint32 TotalAllocationSize)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General
Information:
Returns a single ISV Storage Factory Partner Allocation
Control List (FPACL) or non-partner Allocation Control List (NACL) entry,
given the entry's handle. FPACL entry handles are returned by the methods
AddStorageFpaclEntry and EnumerateStorageAllocEntries. NACL entry handles are
returned by
EnumerateStorageAllocEntries.
Qualifiers:
-------------
ValueMap={0,
1, 2053}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR,
PT_STATUS_INVALID_HANDLE}
Parameters:
--------------
- Handle
- General Information:
Specifies the FPACL or NACL entry to
fetch.
Qualifiers:
-------------
Required
IN
- AttrType
- General Information:
The type of application attributes in
this entry. This parameter should always return a value of
1.
Qualifiers:
-------------
OUT
- ApplicationName
- General Information:
Name of an ISV storage
application.
Qualifiers:
-------------
OUT
MaxLen=64
- VendorName
- General Information:
Name of the ISV
vendor.
Qualifiers:
-------------
OUT
MaxLen=64
- IsPartner
- General Information:
TRUE if this application is a partner
application. FALSE
otherwise.
Qualifiers:
-------------
OUT
- TotalAllocationSize
- General Information:
Maximum size, in bytes, of storage area
an application of this type can
allocate.
Qualifiers:
-------------
OUT
UpdateStorageFpaclEntry
public uint32 UpdateStorageFpaclEntry([IN]uint32 Handle, [IN]uint32 NewAllocationSize)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General
Information:
Updates the allocation size of an existing entry in the
ISV Storage Factory Partner Allocation Control List (FPACL), given the entry's
handle and the new size. FPACL entry handles are returned by the methods
AddStorageFpaclEntry and EnumerateStorageAllocEntries. If the method increases
the allowed allocation size, then it will succeed. Decreasing the size will
only succeed if the currently allocated size for this application does not
exceed the new size. Note: Non-partner allocation control list (NACL) entries
cannot be updated using this function. The allowed allocation size for
non-partner applications can be set using the SetGlobalStorageAttributes
method.
Qualifiers:
-------------
ValueMap={0, 1, 15, 36,
38, 2053, 2075}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR,
PT_STATUS_INVALID_BYTE_COUNT, PT_STATUS_INVALID_PARAMETER,
PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED, PT_STATUS_INVALID_HANDLE,
PT_STATUS_AUDIT_FAIL}
Parameters:
--------------
- Handle
- General Information:
Handle of the FPACL entry to
update.
Qualifiers:
-------------
Required
IN
- NewAllocationSize
- General Information:
Specifies the new maximum size, in bytes,
of storage area that an application of this type can allocate. The size must
be a multiple of
4KB.
Qualifiers:
-------------
Required
IN
RemoveStorageFpaclEntry
public uint32 RemoveStorageFpaclEntry([IN]uint32 Handle)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General Information:
This
function removes an entry from the ISV Storage Factory Partner Allocation
Control List (FPACL), given the entry's handle. FPACL entry handles are
returned by the methods AddStorageFpaclEntry and EnumerateStorageAllocEntries.
If an application using this FPACL entry has registered, then this operation
will fail. The applications using the entry must be removed before the entry
itself can be removed. Note: Non-partner allocation control list (NACL)
entries cannot be removed using this function. NACL entries are removed when
all application instances of the non-partner application are removed from the
device.
Qualifiers:
-------------
ValueMap={0, 1, 2053,
2056, 2075}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR,
PT_STATUS_INVALID_HANDLE, PT_STATUS_STORAGE_ACL_ENTRY_IN_USE,
PT_STATUS_AUDIT_FAIL}
Parameters:
--------------
- Handle
- General Information:
Handle of the FPACL entry to be
removed.
Qualifiers:
-------------
Required
IN
Get
public Get([OUT]AMT_ThirdPartyDataStorageAdministrationService Instance)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_STORAGE_ADMIN_REALM
General Information:
Gets
the representation of the instance
Pull
public Pull([IN]String EnumerationContext, [IN]String MaxElements)
- Permission Information:
All users permitted to use method, only
instances to whom the user has permissions will be returned
General
Information:
Pulls instances of this class, following an Enumerate
operation
Enumerate
public Enumerate()
- Permission Information:
All users permitted to use
method
General Information:
Enumerates the instances of this
class
Release
public Release([IN]String EnumerationContext)
- Permission Information:
All users permitted to use
method
General Information:
Releases an enumeration
context