Skip to content

Commit ee81eb5

Browse files
authored
Merge pull request #1062 from get-itips/patch-25
Added a description for parameters
2 parents 9d875a0 + 72a292b commit ee81eb5

File tree

1 file changed

+58
-18
lines changed

1 file changed

+58
-18
lines changed

docset/winserver2012-ps/activedirectory/Search-ADAccount.md

Lines changed: 58 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ Returns all users, computers and service accounts that are disabled in the LDS i
290290
## PARAMETERS
291291

292292
### -AccountDisabled
293-
{{Fill AccountDisabled Description}}
293+
Returns account objects that are disabled.
294294

295295
```yaml
296296
Type: SwitchParameter
@@ -305,7 +305,7 @@ Accept wildcard characters: False
305305
```
306306
307307
### -AccountExpired
308-
{{Fill AccountExpired Description}}
308+
Returns account objects that are expired.
309309
310310
```yaml
311311
Type: SwitchParameter
@@ -320,7 +320,7 @@ Accept wildcard characters: False
320320
```
321321
322322
### -AccountExpiring
323-
{{Fill AccountExpiring Description}}
323+
Returns account objects that will expire in the specified TimeSpan.
324324
325325
```yaml
326326
Type: SwitchParameter
@@ -335,7 +335,7 @@ Accept wildcard characters: False
335335
```
336336
337337
### -AccountInactive
338-
{{Fill AccountInactive Description}}
338+
Returns all accounts that have been inactive in the specified TimeSpan.
339339
340340
```yaml
341341
Type: SwitchParameter
@@ -350,7 +350,9 @@ Accept wildcard characters: False
350350
```
351351
352352
### -AuthType
353-
{{Fill AuthType Description}}
353+
The type of authentication to run the cmdlet. Allowed values are
354+
Negotiate
355+
Basic
354356
355357
```yaml
356358
Type: ADAuthType
@@ -366,7 +368,7 @@ Accept wildcard characters: False
366368
```
367369
368370
### -ComputersOnly
369-
{{Fill ComputersOnly Description}}
371+
Limits the search only to computer objects.
370372
371373
```yaml
372374
Type: SwitchParameter
@@ -381,7 +383,7 @@ Accept wildcard characters: False
381383
```
382384
383385
### -Credential
384-
{{Fill Credential Description}}
386+
PSCredential object representing the credentials of the user to use to run the cmdlet.
385387
386388
```yaml
387389
Type: PSCredential
@@ -396,7 +398,7 @@ Accept wildcard characters: False
396398
```
397399
398400
### -DateTime
399-
{{Fill DateTime Description}}
401+
Enter a DateTime object, such as one that the Get-Date cmdlet returns, or a string that can be converted to a date and time, such as "April 19, 2012 15:00", "12/31", or "3am". DateTime objects, and strings that are converted to DateTime objects, are automatically adjusted to be compatible with the date and time formats selected for the local computer in Region and Language in Control Panel.
400402
401403
```yaml
402404
Type: DateTime
@@ -411,7 +413,7 @@ Accept wildcard characters: False
411413
```
412414
413415
### -LockedOut
414-
{{Fill LockedOut Description}}
416+
Returns all account objects that have been locked out.
415417
416418
```yaml
417419
Type: SwitchParameter
@@ -426,7 +428,7 @@ Accept wildcard characters: False
426428
```
427429
428430
### -PasswordExpired
429-
{{Fill PasswordExpired Description}}
431+
Returns all account objects that have expired password.
430432
431433
```yaml
432434
Type: SwitchParameter
@@ -441,7 +443,7 @@ Accept wildcard characters: False
441443
```
442444
443445
### -PasswordNeverExpires
444-
{{Fill PasswordNeverExpires Description}}
446+
Returns all account objects which password never expires.
445447
446448
```yaml
447449
Type: SwitchParameter
@@ -456,7 +458,9 @@ Accept wildcard characters: False
456458
```
457459
458460
### -ResultPageSize
459-
{{Fill ResultPageSize Description}}
461+
Specifies the number of objects to include in one page for an Active Directory Domain Services query.
462+
463+
The default is 256 objects per page.
460464
461465
```yaml
462466
Type: Int32
@@ -471,7 +475,7 @@ Accept wildcard characters: False
471475
```
472476
473477
### -ResultSetSize
474-
{{Fill ResultSetSize Description}}
478+
Specifies the maximum number of objects to return for an Active Directory Domain Services query. If you want to receive all of the objects, set this parameter to $Null (null value). You can use Ctrl+C to stop the query and return of objects.
475479
476480
```yaml
477481
Type: Int32
@@ -486,7 +490,16 @@ Accept wildcard characters: False
486490
```
487491
488492
### -SearchBase
489-
{{Fill SearchBase Description}}
493+
Specifies an Active Directory path to search under.
494+
495+
When you run a cmdlet from an Active Directory provider drive, the default value of this parameter is the current path of the drive.
496+
497+
When you run a cmdlet outside of an Active Directory provider drive against an AD DS target, the default value of this parameter is the default naming context of the target domain.
498+
499+
When you run a cmdlet outside of an Active Directory provider drive against an AD LDS target, the default value is the default naming context of the target LDS instance if one has been specified by setting the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. If no default naming context has been specified for the target AD LDS instance, then this parameter has no default value.
500+
501+
When the value of the SearchBase parameter is set to an empty string and you are connected to a GC port, all partitions will be searched. If the value of the SearchBase parameter is set to an empty string and you are not connected to a GC port, an error will be thrown.
502+
490503
491504
```yaml
492505
Type: String
@@ -501,7 +514,16 @@ Accept wildcard characters: False
501514
```
502515
503516
### -SearchScope
504-
{{Fill SearchScope Description}}
517+
Specifies the scope of an Active Directory search.
518+
The acceptable values for this parameter are:
519+
520+
- Base or 0
521+
- OneLevel or 1
522+
- Subtree or 2
523+
524+
A Base query searches only the current path or object.
525+
A OneLevel query searches the immediate children of that path or object.
526+
A Subtree query searches the current path or object and all children of that path or object.
505527
506528
```yaml
507529
Type: ADSearchScope
@@ -517,7 +539,25 @@ Accept wildcard characters: False
517539
```
518540
519541
### -Server
520-
{{Fill Server Description}}
542+
Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server.
543+
The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.
544+
545+
Domain name values:
546+
547+
- Fully qualified domain name (FQDN)
548+
- NetBIOS name
549+
550+
Directory server values:
551+
552+
- Fully qualified directory server name
553+
- NetBIOS name
554+
- Fully qualified directory server name and port
555+
556+
The default value for the *Server* parameter is determined by one of the following methods in the order that they are listed:
557+
558+
- By using *Server* value from objects passed through the pipeline.
559+
- By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive.
560+
- By using the domain of the computer running PowerShell.
521561
522562
```yaml
523563
Type: String
@@ -532,7 +572,7 @@ Accept wildcard characters: False
532572
```
533573
534574
### -TimeSpan
535-
{{Fill TimeSpan Description}}
575+
Enter a timespan object, such as one that the New-TimeSpan cmdlet returns or a string that can be converted to a timespan object, such as "30:00:00".
536576
537577
```yaml
538578
Type: TimeSpan
@@ -547,7 +587,7 @@ Accept wildcard characters: False
547587
```
548588
549589
### -UsersOnly
550-
{{Fill UsersOnly Description}}
590+
Limits the search to only user objects.
551591
552592
```yaml
553593
Type: SwitchParameter

0 commit comments

Comments
 (0)