Get-QARSAccessTemplate
From PowerGUI Wiki
Retrieve Access Template objects from ActiveRoles Server. This cmdlet requires a connection to be established to the ActiveRoles Server Administration Service by supplying the Proxy parameter.
Contents |
Syntax
Get-QARSAccessTemplate [[-Identity] <IdentityParameter>] [-ObjectAttributes <Object>] [-ldapFilter <String>] [-SearchRoot <IdentityParameter>] [-SearchScope <SearchScope>] [-PageSize <Int32>] [-SizeLimit <Int32>] [-Predefined [<Boolean>]] [-Description <String>] [-Proxy] [-Service <String>] [-ConnectionAccount <String>] [-ConnectionPassword <SecureString>] [-Credential <PSCredential>] [-Connection <ArsConnection>] [-UseGlobalCatalog] [<CommonParameters>]
Detailed Description
Use this cmdlet to retrieve ActiveRoles Server Access Template objects that meet the conditions you specify. Each Access Template object contains information about a certain Access Template. Access Template objects can be used as input to *-QARSAccessTemplateLink cmdlets for managing Access Template links. For background information about Access Templates, see ActiveRoles Server Administrator Guide.
The cmdlet has optional parameters that determine the server and the security context for the operation. The connection parameters could be omitted since a connection to a server is normally established prior to using this cmdlet. In this case, the server and the security context are determined by the Connect-QADService cmdlet.
If you do not use Connect-QADService and have no connection established prior to using a cmdlet, then the connection settings, including the server and the security context, are determined by the connection parameters of the first cmdlet you use. Subsequent cmdlets will use those settings by default.
Note that this cmdlet requires a connection to the ActiveRoles Server Administration Service, so the Proxy parameter must be used to establish a connection.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Identity | If you want the cmdlet to retrieve a single Access Template, specify the name, canonical name, or distinguished name (DN) of the Access Template as the value of this parameter. If you want to search for Access Templates by other properties (for example, using an LDAP filter), omit this parameter. | false | true (ByValue, ByPropertyName) | |
| ObjectAttributes | Specify an associative array that defines the Access Template attributes to search. The array syntax:
@{attr1='val1';attr2='val2';...} In this syntax, each of the key-value pairs is the LDAP display name and the value of an attribute to search. A value may include an asterisk character - a wildcard representing any group of characters. For information about associative arrays, type the following command at the PowerShell command-prompt: help about_associative_array | false | false | |
| ldapFilter | Specify the LDAP search filter that defines your search criteria. Note that the search filter string is case-sensitive.
The cmdlet disregards this parameter if an Identity value is supplied. If you want this parameter to have effect, do not supply any Identity value on the command line. Instead, supply a SearchRoot value. With the LdapFilter parameter, the cmdlet disregards the attribute-specific parameters. If you want to define search criteria based on specific attributes, do not supply LdapFilter on the command line. | false | false | |
| SearchRoot | Specify the DN, GUID, or canonical name of the container to search. By default, the cmdlet searches the entire sub-tree of which SearchRoot is the topmost object (sub-tree search). This default behavior can be altered by using the SearchScope parameter.
The search criteria are defined by either the LdapFilter parameter value or the values of attribute-specific parameters. The cmdlet disregards this parameter if an Identity value is supplied. If you want this parameter to have effect, do not supply any Identity value on the command line. | false | false | |
| SearchScope | Specify one of these parameter values:
'Base' - Limits the search to the base (SearchRoot) object. The result contains a maximum of one object. 'OneLevel' - Searches the immediate child objects of the base (SearchRoot) object, excluding the base object. 'Subtree' - Searches the whole sub-tree, including the base (SearchRoot) object and all its child objects. Normally, if this parameter is not supplied, the cmdlet performs a Subtree search. You can view or modify this default setting by using the Get-QADPSSnapinSettings or Set-QADPSSnapinSettings cmdlet, respectively. | false | false | |
| PageSize | Set the maximum number of items in each page of the search results that will be returned by the cmdlet. After the directory server has found the number of objects that are specified by this parameter, it will stop searching and return the results to the cmdlet. When the cmdlet requests more data, the server will restart the search where it left off. You can use this setting to adjust the number of requests (network calls) to the directory server issued by the cmdlet during a search.
Normally, the default page size is 50. You can view or modify this default setting by using the Get-QADPSSnapinSettings or Set-QADPSSnapinSettings cmdlet, respectively. | false | false | |
| SizeLimit | Set the maximum number of items to be returned by the cmdlet. Normally, the default size limit is 1000. You can view or modify this default setting by using the Get-QADPSSnapinSettings or Set-QADPSSnapinSettings cmdlet, respectively. | false | false | |
| Predefined | Set the value of this parameter to 'true' for the cmdlet to retrieve only those Access Templates that are marked "predefined" in ActiveRoles Server. The predefined Access Templates are installed with ActiveRoles Server, and cannot be modified or deleted. | false | false | |
| Description | Specify the description (or a part of description) of Access Templates you want the cmdlet to retrieve. | false | false | |
| Proxy | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Service | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| ConnectionAccount | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| ConnectionPassword | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Credential | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Connection | For parameter description, see help on the Connect-QADService cmdlet. | false | true (ByValue) | |
| UseGlobalCatalog | For parameter description, see help on the Connect-QADService cmdlet. | false | false |
Examples
Example 1
connect-QADService -Proxy C:\PS>get-QARSAccessTemplate -SearchRoot 'Configuration/Access Templates/Builtin' -Predefined $true | format-List Name, ParentContainerDN
Connect to any available Administration Service and list the names of all pre-defined ActiveRoles Server Access Templates located in a certain container.
Example 2
connect-QADService -Proxy C:\PS>get-QARSAccessTemplate -SearchRoot 'Configuration/Access Templates/Active Directory' -SearchScope 'OneLevel' -Predefined $true | format-List Name
List all general-purpose Access Templates for Active Directory data management that are included with ActiveRoles Server by default.
