Come and Check our BETA Alpha version of Powershellcenter.net
Send me your comment to Powershell@powershellcenter.com

Synopsis

Modify default settings that apply to all cmdlets of this PowerShell snap-in.

This cmdlet is part of the Quest ActiveRoles Server product. Use Get-QARSProductInfo to view information about ActiveRoles Server.

Syntax

Set-QADPSSnapinSettings [-DefaultExcludedProperties <string[]>] [-DefaultOutputPropertiesForAdObject <string[]>] [-DefaultOutputPropertiesForComputerObject <string[]>] [-DefaultOutputPropertiesForGroupObject <string[]>] [-DefaultOutputPropertiesForPasswordSettingsObject <string[]>] [-DefaultOutputPropertiesForUserObject <string[]>] [-DefaultPageSize <int>] [-DefaultPropertiesExcludedFromNonBaseSearch <string[]>] [-DefaultSearchScope {Base | OneLevel | Subtree}] [-DefaultSizeLimit <int>] [-DefaultWildcardMode <WildcardMode>] [-Integer8AttributesThatContainDateTimes <string[]>] [-Integer8AttributesThatContainNegativeTimeSpans <string[]>] [<CommonParameters>]

Detailed Description

You can use this cmdlet to modify some default settings that have effect within this PowerShell snap-in on any cmdlet where those settings are applicable. The changes you make to default settings are in effect during the current PowerShell session, and are discarded once you close the PowerShell console window. To view the default settings that are currently in effect, use the Get-QADPSSnapinSettings cmdlet.

Parameters

-DefaultExcludedProperties [<string[]>]

Use this parameter to specify the attributes that are excluded from processing by the UseDefaultExcludedProperties parameter on any particular cmdlet. Supply a list of the attribute LDAP display names as the parameter value.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   false
Accept wildcard characters?   false

-DefaultOutputPropertiesForAdObject [<string[]>]

Use this parameter to specify the default list of the object attributes that are to be retrieved from the directory and stored in the local memory cache by a Get- cmdlet during a search for objects other than a User, Group, Computer, or Password Settings object. Supply a list of the attribute LDAP display names as the parameter value.

Note: Caching an attribute guarantees that the value of the attribute can be read by using properties of the output object returned by a Get- cmdlet. If a particular attribute is not in the cache, the output object may not have a property that would provide access to the value of the attribute.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   false
Accept wildcard characters?   false

-DefaultOutputPropertiesForComputerObject [<string[]>]

Use this parameter to specify the default list of the Computer object attributes that are to be retrieved from the directory and stored in the local memory cache by a Get- cmdlet during a search for Computer objects. Supply a list of the attribute LDAP display names as the parameter value.

Note: Caching an attribute guarantees that the value of the attribute can be read by using properties of the output object returned by a Get- cmdlet. If a particular attribute is not in the cache, the output object may not have a property that would provide access to the value of the attribute.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   false
Accept wildcard characters?   false

-DefaultOutputPropertiesForGroupObject [<string[]>]

Use this parameter to specify the default list of the Group object attributes that are to be retrieved from the directory and stored in the local memory cache by a Get- cmdlet during a search for Group objects. Supply a list of the attribute LDAP display names as the parameter value.

Note: Caching an attribute guarantees that the value of the attribute can be read by using properties of the output object returned by a Get- cmdlet. If a particular attribute is not in the cache, the output object may not have a property that would provide access to the value of the attribute.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   false
Accept wildcard characters?   false

-DefaultOutputPropertiesForPasswordSettingsObject [<string[]>]

Specify the attributes (an array of their LDAP display names) that you want the Get- cmdlets to output when retrieving objects of the PasswordSettingsObject type from Active Directory. A value for this parameter can be constructed similar to a value for the -DefaultOutputPropertiesForUserObject parameter (see examples).

Required?   false
Position?   named
Default value?  
Accept pipeline input?   false
Accept wildcard characters?   false

-DefaultOutputPropertiesForUserObject [<string[]>]

Use this parameter to specify the default list of the User object attributes that are to be retrieved from the directory and stored in the local memory cache by a Get- cmdlet during a search for User objects. Supply a list of the attribute LDAP display names as the parameter value.

Note: Caching an attribute guarantees that the value of the attribute can be read by using properties of the output object returned by a Get- cmdlet. If a particular attribute is not in the cache, the output object may not have a property that would provide access to the value of the attribute.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   false
Accept wildcard characters?   false

-DefaultPageSize [<int>]

Specify a new default value of the -PageSize parameter for the Get- cmdlets. This page size value is used if the -PageSize parameter is omitted. Initially, the default value of the -PageSize parameter is set to 50.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   false
Accept wildcard characters?   false

-DefaultPropertiesExcludedFromNonBaseSearch [<string[]>]

Use this parameter to specify the attributes that are not to be retrieved from the directory and stored in the local memory cache by any particular Get- cmdlet during a search with the search scope other than 'Base'. Supply a list of the attribute LDAP display names as the parameter value.

Note: If a cmdlet does not cache a particular attribute, then the output object returned by the cmdlet may not have a property that would provide access to the value of the attribute.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   false
Accept wildcard characters?   false

-DefaultSearchScope [<SearchScope>]

Specify a new default value of the SearchScope parameter for the Get- cmdlets. Acceptable vales are: 'Base', 'OneLevel', 'Subtree'. This search scope setting is used if the SearchScope parameter is omitted. Initially, the default value of the SearchScope parameter is set to 'Subtree'.

The following values are permitted for this object type.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   false
Accept wildcard characters?   false

-DefaultSizeLimit [<int>]

Specify a new default value of the -SizeLimit parameter for the Get- cmdlets. This limitation on the size of the search result set is used if the -SizeLimit parameter is omitted. Initially, the default value of the -SizeLimit parameter is set to 1000.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   false
Accept wildcard characters?   false

-DefaultWildcardMode [<WildcardMode>]

Specify a new default value of the -WildcardMode parameter for the Get- cmdlets. Acceptable vales are: 'Ldap', 'PowerShell'. This wildcard mode setting is used if the -WildcardMode parameter is omitted. Initially, the default value of the -WildcardMode parameter is set to 'Ldap'.

Required?   false
Position?   named
Default value?  
Accept pipeline input?   false
Accept wildcard characters?   false

-Integer8AttributesThatContainDateTimes [<string[]>]

Use this parameter to specify the Integer8 attributes whose values you want to be represented as DateTime objects in the output of the Get- cmdlets by default. Supply a list of the attribute LDAP display names as the parameter value.

Note: This setting applies only to the properties of a cmdlet's output object that have the member type of NoteProperty. Such properties are normally added to the output object in order to provide access to the attribute values of the respective directory object that are loaded to the local memory cache but cannot be accessed by using properties of the base object (the object for which the output object serves as a wrapper).

Required?   false
Position?   named
Default value?  
Accept pipeline input?   false
Accept wildcard characters?   false

-Integer8AttributesThatContainNegativeTimeSpans [<string[]>]

Use this parameter to specify the Integer8 attributes whose values you want to be represented as TimeSpan objects in the output of the Get- cmdlets by default. Supply a list of the attribute LDAP display names as the parameter value.

The output TimeSpan objects represent the absolute values of the attributes, and thus indicate positive time intervals regardless of whether an actual attribute value is a negative or positive time interval.

Note: This setting applies only to the properties of a cmdlet's output object that have the member type of NoteProperty. Such properties are normally added to the output object in order to provide access to the attribute values of the respective directory object that are loaded to the local memory cache but cannot be accessed by using properties of the base object (the object for which the output object serves as a wrapper).

Required?   false
Position?   named
Default value?  
Accept pipeline input?   false
Accept wildcard characters?   false

Input Type

Return Type

Notes

Examples

EXAMPLE 1

PS> Set-QADPSSnapinSettings -DefaultSizeLimit 0

Description

-----------

Configure the Get- cmdlets to return all search results by default (rather than limit the search result set to a maximum of 1000 items).

EXAMPLE 2

PS> $list = Get-QADPSSnapinSettings -DefaultOutputPropertiesForUserObject C:\PS>$list += 'msDS-ReplAttributeMetaData' C:\PS>Set-QADPSSnapinSettings -DefaultOutputPropertiesForUserObject $list

Description

-----------

Configure the Get- cmdlets to cache the 'msDS-ReplAttributeMetaData' attribute when retrieving User objects from the directory, in addition to the other attributes that are cached by default.

Caching an attribute guarantees that the value of the attribute can be read by using properties of the output object returned by a Get- cmdlet. Thus, after you have changed configuration so as to cache the 'msDS-ReplAttributeMetaData' attribute, you can view the value of that attribute on a user account by using the following command: Get-QADUser 'MyDomain\JSmith' | Format-Table name, 'msDS-ReplAttributeMetaData'