Group Policy Management Console

Overview of the Group Policy Management Console technology.

To develop Group Policy Management Console, you need these headers:

For programming guidance for this technology, see:

Enumerations

 
GPMBackupType

The type of backup created.
GPMPermissionType

The categories, permissions included in the categories, and the object to which they can be applied.
GPMReportingOptions

Options for Group Policy Management Console reports.
GPMSearchProperty

The property of the search criteria.
GPMStarterGPOType

The Starter Group Policy object is a system Starter Group Policy object or a custom Starter Group Policy object.

Functions

 
Add

Adds entries from the IGPMGPO and IGPMBackup interfaces. The method updates any entries that are already present in the migration table.
Add

Adds a criterion for search operations.
Add

Adds the permission specified in a GPMPermission object to the GPMSecurityInfo collection. You can add a permission that is above the level of existing permissions. For more information about restrictions that apply, see the following Remarks section.
AddEntry

Creates an entry in the migration table. The method updates an existing entry.
Backup

Backs up a Group Policy object (GPO) to the specified directory.
Backup

Creates a backup of the current Starter GPO.
Cancel

The client calls this method to cancel an asynchronous Group Policy Management Console (GPMC) operation. GPMC operations such as backup, restore, import, copy, and report generation can execute asynchronously.
CopyTo

Copies the current Group Policy object (GPO) to the specified domain and then returns a pointer to the copy of the GPO.
CopyTo

The CopyTo method copies the current Starter GPO and returns a pointer to the copy of the Starter GPO.
CreateGPO

Creates and retrieves a GPMGPO object with a default display name. Typically, the caller sets the display name immediately after calling this method.
CreateGPOFromStarterGPO

Creates and retrieves a GPMGPO object from a GPMStarterGPO object.
CreateGPOLink

Links the specified GPO to the specified position in the list of GPOs that are linked to a particular SOM.
CreateMigrationTable

Creates an empty migration table.
CreatePermission

Creates and returns an interface or object that represents the trustee (such as a user, computer or security group) and permission that applies to a single object; for example, to a GPO, SOM or a WMI filter.
CreateQueryResults

Executes a Resultant Set of Policy (RSoP) query.
CreateSearchCriteria

Creates and returns a GPMSearchCriteria that represents the criteria to use for performing search operations when you use the Group Policy Management Console (GPMC) interfaces.
CreateStarterGPO

Creates and retrieves a GPMStarterGPO object.
CreateTrustee

Creates and returns a GPMTrustee from which you can retrieve information about a trustee.
Delete

Removes the Group Policy object (GPO) backup from the backup directory and from the file system.
Delete

Deletes a Group Policy object (GPO) from the directory service and from the system volume folder (SYSVOL).
Delete

Removes the GPO link from the scope of management (SOM). The method does not delete the GPO.
Delete

Deletes the GPO from the current domain's system volume folder(SysVol).
Delete

Removes the Starter GPO backup from the backup directory, and from the file system.
DeleteEntry

Deletes an entry from the migration table.
ErrorCode

Returns the error that occurred during the GPMC operation.
GenerateReport

Gets the report for the backup Group Policy object (GPO).
GenerateReport

Gets the report for a GPO.
GenerateReport

The GenerateReport method generates a report on the RSoP data.
GenerateReport

Gets the report for the Starter GPO.
GenerateReport

The GenerateReport method gets the report for the backup GPO.
GenerateReportToFile

The GenerateReportToFile method gets the report for the backup Group Policy object (GPO) and then saves the report to a file in a specified path.
GenerateReportToFile

Gets the report for a GPO and then saves the report to a file in a specified path.
GenerateReportToFile

The GenerateReportToFile method generates a report on the RSoP data and saves it to a file at a specified path.
GenerateReportToFile

The GenerateReportToFile method gets the report for the GPO and saves it to a file at a specified path.
GenerateReportToFile

The GenerateReportToFile gets the report for the backup Starter GPO and saves it to a file at a specified path.
get__NewEnum

Retrieves an enumerator for the collection. (IGPMBackupCollection.get__NewEnum)
get__NewEnum

Retrieves an enumerator for the collection. (IGPMCSECollection.get__NewEnum)
get__NewEnum

Retrieves an enumerator for the collection. (IGPMGPOCollection.get__NewEnum)
get__NewEnum

The get_NewEnum method retrieves an enumerator for the collection.
get__NewEnum

Retrieves an enumerator for the collection. (IGPMMapEntryCollection.get__NewEnum)
get__NewEnum

Retrieves an enumerator for the collection. (IGPMSecurityInfo.get__NewEnum)
get__NewEnum

Retrieves an enumerator for the collection. (IGPMSOMCollection.get__NewEnum)
get__NewEnum

Retrieves an enumerator for the collection. (IGPMstarterGPOBackupCollection.get__NewEnum)
get__NewEnum

Retrieves an enumerator for the collection. (IGPMStarterGPOCollection.get__NewEnum)
get__NewEnum

Retrieves an enumerator for the collection. (IGPMStatusMsgCollection.get__NewEnum)
get__NewEnum

Retrieves an enumerator for the collection. (IGPMWMIFilterCollection.get__NewEnum)
get_Count

Returns the number of GPMBackup objects in the collection.
get_Count

Returns the number of client side extensions (CSEs) in the collection.
get_Count

Returns the number of GPOs in the collection. (IGPMGPOCollection.get_Count)
get_Count

Returns the number of GPO links in the collection.
get_Count

Returns the number of map entries in the collection.
get_Count

Returns the number of GPMPermission objects in the collection.
get_Count

Returns the number of SOMs in the collection.
get_Count

Returns the number of GPMStarterGPOBackup objects in the collection.
get_Count

Returns the number of GPOs in the collection. (IGPMStarterGPOCollection.get_Count)
get_Count

Returns the number of messages in the collection.
get_Count

Returns the number of WMI filters in the collection.
get_Item

Given an index, returns a GPMBackup object from the collection.
get_Item

Given an index, returns a client-side extension from the collection.
get_Item

Given an index, returns a pointer to a GPMGPO object from the collection.
get_Item

Given an index, returns a GPO link from the collection.
get_Item

Given an index, returns a map entry from the collection.
get_Item

Given an index, returns a GPMPermission object from the collection.
get_Item

Given an index, returns a SOM from the collection.
get_Item

Given an index, returns a GPMStarterGPOBackup object from the collection.
get_Item

Given an index, returns a pointer to an IGPMGPO interface from the collection.
get_Item

Given an index, returns a message from the collection.
get_Item

Given an index, returns a WMI filter from the collection.
get_SecurityFlags

Retrieves the value of the SecurityFlags property, which represents the portion of the security descriptor to retrieve or set for a GPO.
GetBackup

Retrieves the GPMBackup object that has the specified backup ID (GUID). The backup ID is the ID of the backed-up GPO, not the ID of the GPO.
GetBackup

Retrieves the GPMBackup or GPMStarterGPOBackup object with the specified backup ID. The backup ID is a GUID. The backup ID is the ID of the backed-up Group Policy object (GPO), not the ID of the GPO.
GetBackupDir

Creates and returns a GPMBackupDir object, which you can use to access the GPMBackup and GPMBackupCollection objects.
GetBackupDirEx

For a Group Policy object (GPO), the GetBackupDirEx method creates and returns a GPMBackupDirEx object, which you can use to access a GPMBackup or GPMBackupCollection object.
GetClientSideExtensions

Creates and returns a GPMCSECollection object that allows you to enumerate Group Policy client-side extensions (CSEs) that are registered on the local computer.
GetConstants

Creates and returns a GPMConstants object that allows you to retrieve the value of multiple Group Policy Management Console (GPMC) constants.
GetDomain

Creates and returns a GPMDomain object that corresponds to the specified domain.
GetEntries

Returns a IGPMMapEntryCollection interface.
GetEntry

The GetEntry method gets the entry in the migration table for a specified source field.
GetGPO

Retrieves a GPMGPO object with a specified Group Policy object (GPO) ID. The group policy object ID is represented by a GUID.
GetGPOLinks

Returns a GPMGPOLinksCollection object that contains the GPO links for the scope of management (SOM). The collection is sorted in the SOM link order and contains both enabled and disabled links. See IGPMGPOLink for the definition of SOM link order.
GetInheritedGPOLinks

Returns a GPOLinksCollection object that contains the GPO links that are applied to the scope of management (SOM), including links inherited from parent containers (OUs and domains).
GetMigrationTable

Loads the migration table at a specified path.
GetQueryList

Retrieves the query list stored in the WMI filter.
GetRSOP

Creates and returns a GPMRSOP. You can specify the Resultant Set of Policy (RSoP) mode and a Windows Management Instrumentation (WMI) namespace.
GetSecurityDescriptor

Retrieves a pointer to an IDispatch interface from which the security descriptor for the Group Policy object (GPO) can be retrieved. For script programmers, this method returns a reference to an IADsSecurityDescriptor object.
GetSecurityInfo

Retrieves the set of permissions for the GPO, such as who is granted permission to edit it.
GetSecurityInfo

Returns an object that represents the collection of GPMPermission objects for the scope of management (SOM).
GetSecurityInfo

Retrieves the set of permissions for the Starter GPO, such as who is granted permission to edit it.
GetSecurityInfo

Returns an interface or object that represents the list of permissions for the current WMI filter.
GetSite

Returns the scope of management (SOM) object that corresponds to the site.
GetSitesContainer

Creates and returns a GPMSitesContainer object from which sites can be opened and queried.
GetSOM

Retrieves the IGPMSOM interface that represents the domain or the organizational unit (OU) at the specified path.
GetStarterGPO

Retrieves a GPMStarterGPO object that has a specified Group Policy object ID.
GetWMIFilter

Retrieves a GPMWMIFilter object for the specified path.
GetWMIFilter

Retrieves the GPMWMIFilter object linked to the Group Policy object (GPO).
Import

Imports the policy settings from the specified GPMBackup object.
InitializeReporting

The InitializeReporting method sets the location to search for .adm files. This method initializes reporting in an asynchronous manner.
InitializeReportingEx

Sets the location to search for .adm files and the reporting option to determine whether to include comments in the report. This method initializes reporting in an asynchronous manner.
IsACLConsistent

Checks for the consistency of ACLs between the Directory Service and the system volume folder (SysVol).
IsComputerEnabled

Checks whether the client-side extension can be called during the processing of computer policy.
IsComputerEnabled

Checks whether the computer policies in the GPO are enabled.
IsUserEnabled

Checks whether the client-side extension can be called during the processing of user policy.
IsUserEnabled

Checks whether the user policies in the GPO are enabled.
LoadStarterGPO

Opens a Starter Group Policy object (GPO) cabinet (CAB) file and imports it into the domain.
LoggingEnumerateUsers

Enumerates all users who have logging mode data on a specific computer.
MakeACLConsistent

Makes ACLs consistent on the Directory Service and the system volume folder (SysVol) of the GPO. IsACLConsistent can be used to check for consistency of ACLs between the Directory Service and system volume folder (SysVol).
OperationCode

Returns a code related to the GPMC operation.
OverallStatus

Returns the overall status of a GPMC operation, such as a copy, restore, backup, or import. If no error occurred during the operation, the method returns a success code; otherwise the method returns a failure code.
ReleaseQueryResults

Releases the WMI namespace allocated by calls to the IGPMRSOP::CreateQueryResults method and by calls to the IGPM::GetRSOP method.
Remove

Removes the permission specified in a given GPMPermission object from the GPMSecurityInfo collection.
RemoveTrustee

Removes all policy-related permissions for the specified trustee. A trustee is a user, computer, or security group that can be granted permissions on a GPO, SOM, or WMI filter.
RestoreGPO

Restores a Group Policy object (GPO) from a GPMBackup object.
RestoreStarterGPO

Restores the Starter Group Policy object (GPO) from a GPMStarterGPOBackup object.
Save

Saves the migration table currently in memory in a specified location.
Save

Saves all Starter GPO settings into a single CAB file.
SearchBackups

Executes a search for the GPMBackup object according to the specified criteria, and returns a GPMBackupCollection object.
SearchBackups

Executes a search for a GPMBackup object or an IGPMStarterGPOBackup interface according to the specified criteria, and returns a GPMBackupCollection or GPMStarterGPOBackupCollection object.
SearchGPOs

Executes a search for GPMGPO objects in the domain and then returns a GPMGPOCollection object.
SearchSites

Retrieves a collection of scope of management (SOM) objects based on the specified search criteria. This method returns only site objects.
SearchSOMs

Executes a search for GPMSOM objects (domains and organizational units) in the domain and then returns a GPMSOMCollection object.
SearchStarterGPOs

Executes a search for GPMStarterGPO objects.
SearchWMIFilters

Executes a search for GPMWMIFilter objects in the domain and then returns a GPMWMIFilterCollection object.
SetComputerEnabled

Enables or disables the computer settings in the GPO.
SetSecurityDescriptor

Sets the security descriptor for the GPO. The method replaces the existing security descriptor.
SetSecurityInfo

Sets the list of permissions for the group policy object (GPO), such as who is granted permission to edit it. The method replaces the existing list of permissions.
SetSecurityInfo

Sets the list of permissions for the scope of management (SOM) to that of the specified object.
SetSecurityInfo

Sets the list of permissions for the Group Policy object (GPO).
SetSecurityInfo

Sets the list of permissions for the current WMI filter to that specified by the object.
SetUserEnabled

Enables or disables the user settings in the GPO.
SetWMIFilter

Links the GPMWMIFilter object to the current Group Policy object (GPO). This method can also be used to unlink existing WMI filters from the GPO.
Status

The server calls this method to notify the client about the status of a Group Policy Management Console (GPMC) operation.
UpdateDestination

Updates the destination field of an entry in a migration table. You can specify the destination option and the destination.
Validate

Validates the migration table.

Interfaces

 
IGPM

The IGPM interface provides methods that access other interfaces of the Group Policy Management Console (GPMC) and methods that create other objects on which various search operations can be performed.
IGPM2

The IGPM2 interface extends the GPMBackupDir and InitializeReporting methods of the IGPM interface of the Group Policy Management Console (GPMC).
IGPMAsyncCancel

A pointer to the IGPMAsyncCancel interface is returned to the client by the Group Policy Management Console (GPMC) method that the client calls asynchronously.
IGPMAsyncProgress

The IGPMAsyncProgress interface can be implemented by the client and passed as an input parameter to the Group Policy Management Console (GPMC) methods that can execute asynchronously.
IGPMBackup

The IGPMBackup interface supports methods that allow you to delete GPMBackup objects and to retrieve various properties of GPMBackup objects.
IGPMBackupCollection

The IGPMBackupCollection interface contains methods that enable applications to access a collection of GPMBackup objects when using the Group Policy Management Console (GPMC) interfaces.
IGPMBackupDir

The IGPMBackupDir interface supports methods that allow you to query GPMBackup and GPMBackupCollection objects when you use the Group Policy Management Console (GPMC) interfaces.
IGPMBackupDirEx

The IGPMBackupDirEx interface supports methods that allow you to query GPMBackup, GPMBackupCollection, GPMStarterGPOBackup, and GPMStarterGPOBackupCollection objects when you are using the Group Policy Management Console (GPMC) interfaces.
IGPMClientSideExtension

The IGPMClientSideExtension interface supports methods that allow you to query client-side extension properties when you use the Group Policy Management Console (GPMC) interfaces.
IGPMConstants

The IGPMConstants interface supports methods that retrieve the value of multiple Group Policy Management Console (GPMC) constants. To create a GPMConstants object, call the IGPM::GetConstants method.
IGPMConstants2

The IGPMConstants2 interface supports methods that retrieve the value of multiple Group Policy Management Console (GPMC) constants.
IGPMCSECollection

The IGPMCSECollection interface contains methods that enable applications to query a collection of client-side extensions (CSEs) when you use the Group Policy Management Console (GPMC) interfaces.
IGPMDomain

Represents a given domain and supports methods that allow you to query scope of management (SOM) objects, create, restore and query GPOs, and create and query WMI filters when you are using the Group Policy Management Console (GPMC) interfaces.
IGPMDomain2

Represents a given domain and supports methods that allow you to query scope of management (SOM) objects, create, restore and query Starter GPOs, and create and query WMI filters when you are using the Group Policy Management Console (GPMC) interfaces.
IGPMGPO

The IGPMGPO interface supports methods that enable you to manage Group Policy Objects (GPOs) in the directory service.
IGPMGPO2

The IGPMGPO2 interface supports methods that enable you to manage Group Policy objects (GPOs) and Starter Group Policy objects in the directory service.
IGPMGPOCollection

The IGPMGPOCollection interface contains methods that enable applications to access a collection of Group Policy Objects (GPOs) when using the Group Policy Management Console (GPMC) interfaces.
IGPMGPOLink

The IGPMGPOLink interface supports methods that allow you to remove a GPO link from the scope of management (SOM), and to set and retrieve various properties of GPO links, including enabling and enforcing links.
IGPMGPOLinksCollection

The IGPMGPOLinksCollection interface contains methods that enable applications to access a collection of GPO links when using the Group Policy Management (GPMC) interfaces.
IGPMMapEntry

The IGPMMapEntry interface provides access to a map entry.
IGPMMapEntryCollection

The IGPMMapEntryCollection interface enables applications to access map entry objects.
IGPMMigrationTable

The IGPMMigrationTable interface provides an interface to a migration table.
IGPMPermission

The IGPMPermission interface contains methods to retrieve permission-related properties when using the GPMC.
IGPMResult

The IGPMResult interface contains methods to retrieve status message information while performing various types of GPO processing operations such as restore, import, copy and backup.
IGPMRSOP

The IGPMRSOP interface provides methods that support making Resultant Set of Policy (RSoP) queries in both logging and planning mode.
IGPMSearchCriteria

The IGPMSearchCriteria interface allows you to define the criteria to use for search operations when using the Group Policy Management Console (GPMC) interfaces. To create a GPMSearchCriteria object, call the IGPM::CreateSearchCriteria method.
IGPMSecurityInfo

The IGPMSecurityInfo interface defines the methods of the GPMSecurityInfo collection. This collection represents a set of policy-related permissions that can be set on a particular object, such as a scope of management (SOM), a GPO, or a WMI filter.
IGPMSitesContainer

The IGPMSitesContainer interface provides the methods required to access the scope of management (SOM) objects that represent sites in a forest.
IGPMSOM

The IGPMSOM interface contains methods that allow you to create and retrieve GPO links for a scope of management (SOM), and to set and retrieve security attributes and various properties for a SOM. A SOM can be a site, domain or OU.
IGPMSOMCollection

The IGPMSOMCollection interface represents a collection of GPMSOM objects.
IGPMStarterGPO

The IGPMStarterGPO interface supports methods that enable you to manage Starter Group Policy Objects (GPOs) in the directory service.
IGPMStarterGPOBackup

The IGPMStarterGPOBackup interface supports methods that allow you to delete GPMStarterGPOBackup objects and to retrieve various properties of GPMStarterGPOBackup objects.
IGPMStarterGPOBackupCollection

The IGPMStarterGPOBackupCollection interface contains methods that enable applications to access a collection of GPMStarterGPOBackup objects when using the Group Policy Management Console (GPMC) interfaces.
IGPMStarterGPOCollection

The IGPMStarterGPOCollection interface contains methods that enable applications to access a collection of Group Policy Objects (GPOs) when using the Group Policy Management Console (GPMC) interfaces.
IGPMStatusMessage

The IGPMStatusMessage interface contains property methods that retrieve various properties of status messages related to GPO operations.
IGPMStatusMsgCollection

The IGPMStatusMsgCollection interface contains methods that enable applications to access a collection of status messages when using the Group Policy Management Console (GPMC) interfaces.
IGPMTrustee

The IGPMTrustee interface contains methods to retrieve information about a given trustee when using the Group Policy Management Console (GPMC).
IGPMWMIFilter

The IGPMWMIFilter interface contains methods that allow you to set and retrieve security attributes and various properties for a WMI filter. WMI filter queries are specified using WMI Query Language (WQL).
IGPMWMIFilterCollection

The IGPMWMIFilterCollection interface contains methods that enable applications to access a collection of WMI filters when using the Group Policy Management Console (GPMC) interfaces.