Get-QADPSSnapinSettings
From PowerGUI Wiki
View 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.
Contents |
Syntax
Get-QADPSSnapinSettings [-DefaultExcludedProperties] [-DefaultOutputPropertiesForAdObject] [-DefaultOutputPropertiesForComputerObject] [-DefaultOutputPropertiesForGroupObject] [-DefaultOutputPropertiesForPasswordSettingsObject] [-DefaultOutputPropertiesForUserObject] [-DefaultPageSize] [-DefaultPropertiesExcludedFromNonBaseSearch] [-DefaultSearchScope] [-DefaultSizeLimit] [-DefaultWildcardMode] [-Integer8AttributesThatContainDateTimes] [-Integer8AttributesThatContainNegativeTimeSpans] [<CommonParameters>]
Detailed Description
You can use this cmdlet to view some default settings that have effect within this PowerShell snap-in on any cmdlet where those settings are applicable. To change default settings, use the Set-QADPSSnapinSettings cmdlet.
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| DefaultExcludedProperties | This parameter causes the cmdlet to return a list of the attributes that are excluded from processing by the UseDefaultExcludedProperties parameter on any particular cmdlet. | false | false | |
| DefaultOutputPropertiesForAdObject | This parameter causes the cmdlet to return the default list of the object attributes that are 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.
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. | false | false | |
| DefaultOutputPropertiesForComputerObject | This parameter causes the cmdlet to return the default list of the Computer object attributes that are retrieved from the directory and stored in the local memory cache by a Get- cmdlet during a search for Computer objects.
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. | false | false | |
| DefaultOutputPropertiesForGroupObject | This parameter causes the cmdlet to return the default list of the Group object attributes that are retrieved from the directory and stored in the local memory cache by a Get- cmdlet during a search for Group objects.
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. | false | false | |
| DefaultOutputPropertiesForPasswordSettingsObject | This parameter causes the cmdlet to return the default list of the Password Settings object attributes that are retrieved from the directory and stored in the local memory cache by a Get- cmdlet during a search for Password Settings objects.
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. | false | false | |
| DefaultOutputPropertiesForUserObject | This parameter causes the cmdlet to return the default list of the User object attributes that are retrieved from the directory and stored in the local memory cache by a Get- cmdlet during a search for User objects.
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. | false | false | |
| DefaultPageSize | Supply this parameter on the command line to view the default value of the -PageSize parameter that is used by the Get- cmdlets. This page size value is used if the -PageSize parameter is omitted. | false | false | |
| DefaultPropertiesExcludedFromNonBaseSearch | This parameter causes the cmdlet to return a list of the attributes that are not 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'.
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. | false | false | |
| DefaultSearchScope | Supply this parameter on the command line to view the default value of the SearchScope parameter that is used by the Get- cmdlets. This search scope setting is used if the SearchScope parameter is omitted. | false | false | |
| DefaultSizeLimit | Supply this parameter on the command line to view the default value of the -SizeLimit parameter that is used by the Get- cmdlets. This limitation on the size of the search result set is used if the -SizeLimit parameter is omitted. | false | false | |
| DefaultWildcardMode | Supply this parameter on the command line to view the default value of the -WildcardMode parameter that is used by the Get- cmdlets. This wildcard mode setting is used if the -WildcardMode parameter is omitted. | false | false | |
| Integer8AttributesThatContainDateTimes | This parameter causes the cmdlet to return a list of the Integer8 attributes whose values are represented as DateTime objects in the output of the Get- cmdlets by default. Each attribute is identified by its LDAP display name.
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). | false | false | |
| Integer8AttributesThatContainNegativeTimeSpans | This parameter causes the cmdlet to return a list of the Integer8 attributes whose values are represented as TimeSpan objects in the output of the Get- cmdlets by default. Each attribute is identified by its LDAP display name.
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). | false | false |
Examples
EXAMPLE 1
$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'
