Source code of Windows XP (NT5)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1178 lines
51 KiB

  1. ;//+-------------------------------------------------------------------------
  2. ;//
  3. ;// Microsoft Windows
  4. ;//
  5. ;// Copyright (C) Microsoft Corporation, 2000 - 2000
  6. ;//
  7. ;// File: usage.mc
  8. ;// Author: micretz
  9. ;//--------------------------------------------------------------------------
  10. MessageId=1
  11. SymbolicName=USAGE_DSGET
  12. Language=English
  13. Description: This tool's commands display the selected properties of a specific object in the directory. The dsget commands:
  14. dsget computer - displays properties of computers in the directory.
  15. dsget contact - displays properties of contacts in the directory.
  16. dsget subnet - displays properties of subnets in the directory.
  17. dsget group - displays properties of groups in the directory.
  18. dsget ou - displays properties of ou's in the directory.
  19. dsget server - displays properties of servers in the directory.
  20. dsget site - displays properties of sites in the directory.
  21. dsget user - displays properties of users in the directory.
  22. To display an arbitrary set of attributes of any given object in the directory use the dsquery * command (see examples below).
  23. For help on a specific command, type "dsget <ObjectType> /?" where <ObjectType> is
  24. one of the supported object types shown above. For example, dsget ou /?.
  25. Remarks:
  26. The dsget commands help you to view the properties of a specific object in the directory: the input to dsget is an object and the output is a list of properties for that object. To find all objects that meet a given search criterion, use the dsquery commands (dsquery /?).
  27. The dsget commands support piping of input to allow you to pipe results from the dsquery commands as input to the dsget commands and display detailed information on the objects found by the dsquery commands.
  28. Examples:
  29. To find all users with names starting with "John" and display their office numbers:
  30. dsquery user -name John* | dsget user -office
  31. To display the sAMAccountName, userPrincipalName and department attributes of the object whose DN is ou=Test,dc=microsoft,dc=com:
  32. Dsquery * -startnode ou=Test,dc=microsoft,dc=com -scope base -attr sAMAccountName userPrincipalName department
  33. To read all attributes of any object use the dsquery * command. For example, to read all attributes of the object whose DN is ou=Test,dc=microsoft,dc=com:
  34. Dsquery * -startnode ou=Test,dc=microsoft,dc=com -scope base -attr *
  35. Directory Service command-line tools help:
  36. dsadd /? - help for adding objects.
  37. dsget /? - help for displaying objects.
  38. dsmod /? - help for modifying objects.
  39. dsmove /? - help for moving objects.
  40. dsquery /? - help for finding objects matching search criteria.
  41. dsrm /? - help for deleting objects.
  42. .
  43. MessageId=2
  44. SymbolicName=USAGE_DSGET_USER
  45. Language=English
  46. Description: Displays properties of a user in the directory.
  47. The are two variations of this command. The first
  48. variation allows you to view the properties of multiple users.
  49. The second variation allows you to view the group membership
  50. information of a single user.
  51. Syntax: dsget user <ObjectDN ...>
  52. [-dn]
  53. [-samid]
  54. [-sid]
  55. [-upn]
  56. [-fn]
  57. [-mi]
  58. [-ln]
  59. [-display]
  60. [-empid]
  61. [-desc]
  62. [-office]
  63. [-tel]
  64. [-email]
  65. [-hometel]
  66. [-pager]
  67. [-mobile]
  68. [-fax]
  69. [-iptel]
  70. [-webpg]
  71. [-title]
  72. [-dept]
  73. [-company]
  74. [-mgr]
  75. [-hmdir]
  76. [-hmdrv]
  77. [-profile]
  78. [-loscr]
  79. [-mustchpwd]
  80. [-canchpwd]
  81. [-pwdneverexpires]
  82. [-disabled]
  83. [-acctexpires]
  84. [-reversiblepwd]
  85. [{-s <Server> | -d <Domain>}]
  86. [-u <UserName>]
  87. [-p {<Password> | *}]
  88. [-C]
  89. [-q]
  90. [-L]
  91. dsget user <ObjectDN>
  92. [-memberof [-expand]]
  93. [{-s <Server> | -d <Domain>}]
  94. [-u <UserName>]
  95. [-p {<Password> | *}]
  96. [-C]
  97. [-q]
  98. [-L]
  99. Parameters:
  100. Value Description
  101. <ObjectDN ...> Required/stdin. Distinguished names (DNs) of one
  102. or more users to view.
  103. If the target objects are omitted they
  104. will be taken from standard input (stdin)
  105. to support piping of output from another command
  106. to input of this command. Compare with <ObjectDN> below.
  107. -dn Shows the DN of the user.
  108. -samid Shows the SAM account name of the user.
  109. -sid Shows the user Security ID.
  110. -upn Shows the user principal name of the user.
  111. -fn Shows the first name of the user.
  112. -mi Shows the middle initial of the user.
  113. -ln Shows the last name of the user.
  114. -display Shows the display name of the user.
  115. -empid Shows the user employee ID.
  116. -desc Shows the description of the user.
  117. -office Shows the office location of the user.
  118. -tel Shows the telephone number of the user.
  119. -email Shows the e-mail address of the user.
  120. -hometel Shows the home telephone number of the user.
  121. -pager Shows the pager number of the user.
  122. -mobile Shows the mobile phone number of the user.
  123. -fax Shows the fax number of the user.
  124. -iptel Shows the user IP phone number.
  125. -webpg Shows the user web page URL.
  126. -title Shows the title of the user.
  127. -dept Shows the department of the user.
  128. -company Shows the company info of the user.
  129. -mgr Shows the user's manager.
  130. -hmdir Shows the user home directory.
  131. Displays the drive letter to which the
  132. home directory of the user is mapped
  133. (if the home directory path is a UNC path).
  134. -hmdrv Shows the user's home drive letter
  135. (if home directory is a UNC path).
  136. -profile Shows the user's profile path.
  137. -loscr Shows the user's logon script path.
  138. -mustchpwd Shows if the user must change his/her password
  139. at the time of next logon. Displays: yes or no.
  140. -canchpwd Shows if the user can change his/her password.
  141. Displays: yes or no.
  142. -pwdneverexpires Shows if the user password never expires.
  143. Displays: yes or no.
  144. -disabled Shows if the user account is disabled
  145. for logon or not. Displays: yes or no.
  146. -acctexpires Shows when the user account expires.
  147. Display values: a date when the account expires
  148. or the string "never" if the account never expires.
  149. -reversiblepwd Shows if the user password is allowed to be
  150. stored using reversible encryption (yes or no).
  151. <ObjectDN> Required. DN of group to view.
  152. -memberof Displays the groups of which the user is a member.
  153. -expand Displays a recursively expanded list of groups
  154. of which the user is a member.
  155. {-s <Server> | -d <Domain>}
  156. -s <Server> connects to the domain controller (DC)
  157. with name <Server>. Default: local system.
  158. -d <Domain> connects to a DC in domain <Domain>.
  159. Default: a DC in the logon domain.
  160. -u <UserName> Connect as <UserName>. Default: the logged in user.
  161. -p {<Password> | *} Password for the user <UserName>. If * then prompt for
  162. password.
  163. -C Continuous operation mode: report errors but continue
  164. with next object in argument list when multiple target
  165. objects are specified. Without this option, command
  166. exits on first error.
  167. -q Quiet mode: suppress all output to standard output.
  168. -L Displays the entries in the search result set in a
  169. list format. Default: table format.
  170. Remarks:
  171. The dsget commands help you view the properties of a specific object in the directory:
  172. the input to dsget is an object and the output is a list of properties for that object.
  173. To find all objects that meet a given search criterion, use the dsquery commands
  174. (dsquery /?).
  175. If a value that you supply contains spaces, use quotation marks
  176. around the text (for example, "CN=John Smith,CN=Users,DC=microsoft,DC=com").
  177. If you enter multiple values, the values must be separated by spaces
  178. (for example, a list of distinguished names).
  179. Examples:
  180. To find all users in a given OU whose names start with "jon" and display their
  181. descriptions.
  182. dsquery user -startnode ou=Test,dc=microsoft,dc=com -name jon* | dsget user -desc
  183. Display the list of groups, recursively expanded, to which a given user "Jon
  184. Smith" belongs:
  185. dsget user "cn=Jon Smith,cn=users,dc=microsoft,dc=com" -memberof -expand
  186. See also:
  187. dsget - describes parameters that apply to all commands.
  188. dsget computer - displays properties of computers in the directory.
  189. dsget contact - displays properties of contacts in the directory.
  190. dsget subnet - displays properties of subnets in the directory.
  191. dsget group - displays properties of groups in the directory.
  192. dsget ou - displays properties of ou's in the directory.
  193. dsget server - displays properties of servers in the directory.
  194. dsget site - displays properties of sites in the directory.
  195. dsget user - displays properties of users in the directory.
  196. Directory Service command-line tools help:
  197. dsadd /? - help for adding objects.
  198. dsget /? - help for displaying objects.
  199. dsmod /? - help for modifying objects.
  200. dsmove /? - help for moving objects.
  201. dsquery /? - help for finding objects matching search criteria.
  202. dsrm /? - help for deleting objects.
  203. .
  204. MessageId=3
  205. SymbolicName=USAGE_DSGET_COMPUTER
  206. Language=English
  207. Description: Displays the properties of a computer in the directory.
  208. The are two variations of this command.
  209. The first variation allows you to view the properties
  210. of multiple computers. The second variation allows
  211. you to view the membership information of a single computer.
  212. Syntax: dsget computer <ObjectDN ...>
  213. [-dn]
  214. [-samid]
  215. [-sid]
  216. [-desc]
  217. [-loc]
  218. [-disabled]
  219. [{-s <Server> | -d <Domain>}]
  220. [-u <UserName>]
  221. [-p {<Password> | *}]
  222. [-C]
  223. [-q]
  224. [-L]
  225. dsget computer <ObjectDN>
  226. [-memberof [-expand]]
  227. [{-s <Server> | -d <Domain>}]
  228. [-u <UserName>]
  229. [-p {<Password> | *}]
  230. [-C]
  231. [-q]
  232. [-L]
  233. Parameters:
  234. Value Description
  235. <ObjectDN ...> Required/stdin. Distinguished names (DNs) of one
  236. or more computers to view.
  237. If the target objects are omitted they
  238. will be taken from standard input (stdin)
  239. to support piping of output from another
  240. command to input of this command.
  241. -dn Displays the computer DN.
  242. -samid Displays the computer SAM account name.
  243. -sid Displays the computer Security ID (SID).
  244. -desc Displays the user description.
  245. -loc Displays the computer location.
  246. -disabled Displays if the computer account is
  247. disabled (yes) or not (no).
  248. <ObjectDN> Required. Distinguished name (DN) of the computer to view.
  249. -memberof Displays the groups of which the computer is a member.
  250. -expand Displays the recursively expanded list of groups of
  251. which the computer is a member. This option takes
  252. the immediate group membership list of the computer
  253. and then recursively expands each group in this list to
  254. determine its group memberships and arrive at a
  255. complete set of the groups.
  256. {-s <Server> | -d <Domain>}
  257. -s <Server> connects to the domain controller (DC)
  258. with name <Server>. Default: local system.
  259. -d <Domain> connects to a DC in domain <Domain>.
  260. Default: a DC in the logon domain.
  261. -u <UserName> Connect as <UserName>. Default: the logged in user.
  262. -p {<Password> | *} Password for the user <UserName>. If * then prompt for
  263. password.
  264. -C Continuous operation mode: report errors but continue
  265. with next object in argument list when multiple target
  266. objects are specified. Without this option, command
  267. exits on first error.
  268. -q Quiet mode: suppress all output to standard output.
  269. -L Displays the entries in the search result set in a
  270. list format. Default: table format.
  271. Remarks:
  272. The dsget commands help you view the properties of a specific object in the directory:
  273. the input to dsget is an object and the output is a list of properties for that object.
  274. To find all objects that meet a given search criterion, use the dsquery commands
  275. (dsquery /?).
  276. If a value that you supply contains spaces, use quotation marks
  277. around the text (for example, "CN=DC2,OU=Domain Controllers,DC=microsoft,DC=com").
  278. If you enter multiple values, the values must be separated by spaces
  279. (for example, a list of distinguished names).
  280. Examples:
  281. To find all computers in a given OU whose name starts with "tst" and show their
  282. descriptions.
  283. dsquery computer ou=Test,dc=microsoft,dc=com -name tst* |
  284. dsget computer -desc
  285. To show the list of groups, recursively expanded, to which a given computer
  286. "MyDBServer" belongs:
  287. dsget computer cn=MyDBServer,cn=computers,dc=microsoft,dc=com
  288. -memberof -expand
  289. See also:
  290. dsget - describes parameters that apply to all commands.
  291. dsget computer - displays properties of computers in the directory.
  292. dsget contact - displays properties of contacts in the directory.
  293. dsget subnet - displays properties of subnets in the directory.
  294. dsget group - displays properties of groups in the directory.
  295. dsget ou - displays properties of ou's in the directory.
  296. dsget server - displays properties of servers in the directory.
  297. dsget site - displays properties of sites in the directory.
  298. dsget user - displays properties of users in the directory.
  299. Directory Service command-line tools help:
  300. dsadd /? - help for adding objects.
  301. dsget /? - help for displaying objects.
  302. dsmod /? - help for modifying objects.
  303. dsmove /? - help for moving objects.
  304. dsquery /? - help for finding objects matching search criteria.
  305. dsrm /? - help for deleting objects.
  306. .
  307. MessageId=4
  308. SymbolicName=USAGE_DSGET_GROUP
  309. Language=English
  310. Description: Dispays properties of a group in the directory.
  311. The are two variations of this command. The first
  312. variation allows you to view the properties of multiple groups.
  313. The second variation allows you to view the group membership
  314. information of a single group.
  315. Syntax: dsget group <ObjectDN ...>
  316. [-dn]
  317. [-samid]
  318. [-sid]
  319. [-desc]
  320. [-secgrp]
  321. [-scope]
  322. [{-s <Server> | -d <Domain>}]
  323. [-u <UserName>]
  324. [-p {<Password> | *}]
  325. [-C]
  326. [-q]
  327. [-L]
  328. dsget group <ObjectDN>
  329. [-members [-expand]]
  330. [{-s <Server> | -d <Domain>}]
  331. [-u <UserName>]
  332. [-p {<Password> | *}]
  333. [-C]
  334. [-q]
  335. [-L]
  336. Parameters:
  337. Value Description
  338. <ObjectDN ...> Required/stdin. Distinguished names (DNs) of one
  339. or more groups to view.
  340. If the target objects are omitted they
  341. will be taken from standard input (stdin)
  342. to support piping of output from another command
  343. to input of this command. Compare with <ObjectDN> below.
  344. -dn Displays the group DN.
  345. -samid Displays the groupr SAM account name.
  346. -sid Displays the group Security ID.
  347. -desc Displays the group description.
  348. -secgrp Displays if the group is a security group or not.
  349. -scope Displays the scope of the group - Local, Global
  350. or Universal.
  351. <ObjectDN> Required. DN of group to view.
  352. -memberof Displays the groups of which the group is a member.
  353. This applies to the second instruction set.
  354. -members Displays the members of the group.
  355. -expand For -memberof, displays the recursively expanded
  356. list of groups of which the group is a member.
  357. This option takes the immediate group membership list
  358. of the group and then recursively expands each group
  359. in this list to determine its group memberships
  360. and arrive at a complete set of the groups.
  361. For -member, displays the recursively expanded list
  362. of members of the group. This option takes the
  363. immediate list of members of the group and
  364. then recursively expands each group in this list
  365. to determine its group memberships and arrive
  366. at a complete set of its members.
  367. {-s <Server> | -d <Domain>}
  368. -s <Server> connects to the domain controller (DC)
  369. with name <Server>. Default: local system.
  370. -d <Domain> connects to a DC in domain <Domain>.
  371. Default: a DC in the logon domain.
  372. -u <UserName> Connect as <UserName>. Default: the logged in user.
  373. -p {<Password> | *} Password for the user <UserName>. If * then prompt for
  374. password.
  375. -C Continuous operation mode: report errors but continue
  376. with next object in argument list when multiple target
  377. objects are specified. Without this option, command
  378. exits on first error.
  379. -q Quiet mode: suppress all output to standard output.
  380. -L Displays the entries in the search result set in a
  381. list format. Default: table format.
  382. Remarks:
  383. The dsget commands help you view the properties of a specific object in the directory:
  384. the input to dsget is an object and the output is a list of properties for that object.
  385. To find all objects that meet a given search criterion, use the dsquery commands
  386. (dsquery /?).
  387. If a value that you supply contains spaces, use quotation marks
  388. around the text (for example, "CN=USA Sales,OU=Distribution Lists,DC=microsoft,DC=com").
  389. If you enter multiple values, the values must be separated by spaces
  390. (for example, a list of distinguished names).
  391. Examples:
  392. To find all groups in a given OU whose names start with "adm" and display their
  393. descriptions.
  394. dsquery group -startnode ou=Test,dc=microsoft,dc=com -name adm* |
  395. dsget group -desc
  396. To display the list of members, recursively expanded, of the group "Backup
  397. Operators":
  398. dsget group "CN=Backup Operators,ou=Test,dc=microsoft,dc=com" -members -expand
  399. See also:
  400. dsget - describes parameters that apply to all commands.
  401. dsget computer - displays properties of computers in the directory.
  402. dsget contact - displays properties of contacts in the directory.
  403. dsget subnet - displays properties of subnets in the directory.
  404. dsget group - displays properties of groups in the directory.
  405. dsget ou - displays properties of ou's in the directory.
  406. dsget server - displays properties of servers in the directory.
  407. dsget site - displays properties of sites in the directory.
  408. dsget user - displays properties of users in the directory.
  409. Directory Service command-line tools help:
  410. dsadd /? - help for adding objects.
  411. dsget /? - help for displaying objects.
  412. dsmod /? - help for modifying objects.
  413. dsmove /? - help for moving objects.
  414. dsquery /? - help for finding objects matching search criteria.
  415. dsrm /? - help for deleting objects.
  416. .
  417. MessageId=5
  418. SymbolicName=USAGE_DSGET_OU
  419. Language=English
  420. Description: Displays properties of an organizational unit in the
  421. directory.
  422. Syntax: dsget ou <ObjectDN ...>
  423. [-dn]
  424. [-desc]
  425. [{-s <Server> | -d <Domain>}]
  426. [-u <UserName>]
  427. [-p {<Password> | *}]
  428. [-C]
  429. [-q]
  430. [-L]
  431. Parameters:
  432. Value Description
  433. <ObjectDN ...> Required/stdin. Distinguished names (DNs) of one
  434. or more organizational units (OUs) to view.
  435. If the target objects are omitted they
  436. will be taken from standard input (stdin)
  437. to support piping of output from another
  438. command to input of this command.
  439. -dn Displays the OU DN.
  440. -desc Displays the OU description.
  441. {-s <Server> | -d <Domain>}
  442. -s <Server> connects to the domain controller (DC)
  443. with name <Server>. Default: local system.
  444. -d <Domain> connects to a DC in domain <Domain>.
  445. Default: a DC in the logon domain.
  446. -u <UserName> Connect as <UserName>. Default: the logged in user.
  447. -p {<Password> | *} Password for the user <UserName>. If * then prompt for
  448. password.
  449. -C Continuous operation mode: report errors but continue
  450. with next object in argument list when multiple target
  451. objects are specified. Without this option, command
  452. exits on first error.
  453. -q Quiet mode: suppress all output to standard output.
  454. -L Displays the entries in the search result set in a
  455. list format. Default: table format.
  456. Remarks:
  457. The dsget commands help you view the properties of a specific object in the directory:
  458. the input to dsget is an object and the output is a list of properties for that object.
  459. To find all objects that meet a given search criterion, use the dsquery commands
  460. (dsquery /?).
  461. If a value that you supply contains spaces, use quotation marks
  462. around the text (for example, "OU=Domain Controllers,DC=microsoft,DC=com").
  463. If you enter multiple values, the values must be separated by spaces
  464. (for example, a list of distinguished names).
  465. Examples:
  466. To find all OU's in the current domain and display their descriptions.
  467. dsquery ou -startnode domainroot | dsget ou -desc
  468. See also:
  469. dsget - describes parameters that apply to all commands.
  470. dsget computer - displays properties of computers in the directory.
  471. dsget contact - displays properties of contacts in the directory.
  472. dsget subnet - displays properties of subnets in the directory.
  473. dsget group - displays properties of groups in the directory.
  474. dsget ou - displays properties of ou's in the directory.
  475. dsget server - displays properties of servers in the directory.
  476. dsget site - displays properties of sites in the directory.
  477. dsget user - displays properties of users in the directory.
  478. Directory Service command-line tools help:
  479. dsadd /? - help for adding objects.
  480. dsget /? - help for displaying objects.
  481. dsmod /? - help for modifying objects.
  482. dsmove /? - help for moving objects.
  483. dsquery /? - help for finding objects matching search criteria.
  484. dsrm /? - help for deleting objects.
  485. .
  486. MessageId=6
  487. SymbolicName=USAGE_DSGET_CONTACT
  488. Language=English
  489. Description: Displays properties of a contact in the directory.
  490. Syntax: dsget contact <ObjectDN ...>
  491. [-dn]
  492. [-fn]
  493. [-mi]
  494. [-ln]
  495. [-display]
  496. [-desc]
  497. [-office]
  498. [-tel]
  499. [-email]
  500. [-hometel]
  501. [-pager]
  502. [-mobile]
  503. [-fax]
  504. [-iptel]
  505. [-title]
  506. [-dept]
  507. [-company]
  508. [{-s <Server> | -d <Domain>}]
  509. [-u <UserName>]
  510. [-p {<Password> | *}]
  511. [-C]
  512. [-q]
  513. [-L]
  514. Parameters:
  515. Value Description
  516. <ObjectDN ...> Required/stdin. Distinguished names (DNs) of one
  517. or more contacts to view.
  518. If the target objects are omitted they
  519. will be taken from standard input (stdin)
  520. to support piping of output from another
  521. command to input of this command.
  522. -dn Displays the contact DN.
  523. -fn Displays the contact first name.
  524. -mi Displays the contact middle initial.
  525. -ln Displays the contact last name.
  526. -display Displays the contact display name.
  527. -desc Displays the contact description.
  528. -office Displays the contact office location.
  529. -tel Displays the contact telephone#.
  530. -email Displays the contact e-mail address.
  531. -hometel Displays the contact home phone#.
  532. -pager Displays the contact pager#.
  533. -mobile Displays the contact mobile#.
  534. -fax Displays the contact fax#.
  535. -iptel Displays the contact IP phone#.
  536. -title Displays the contact title.
  537. -dept Displays the contact department.
  538. -company Displays the contact company info.
  539. {-s <Server> | -d <Domain>}
  540. -s <Server> connects to the domain controller (DC)
  541. with name <Server>. Default: local system.
  542. -d <Domain> connects to a DC in domain <Domain>.
  543. Default: a DC in the logon domain.
  544. -u <UserName> Connect as <UserName>. Default: the logged in user.
  545. -p {<Password> | *}
  546. Password for the user <UserName>. If * then prompt for
  547. password.
  548. -C Continuous operation mode: report errors but continue
  549. with next object in argument list when multiple target
  550. objects are specified. Without this option, command
  551. exits on first error.
  552. -q Quiet mode: suppress all output to standard output.
  553. -L Displays the entries in the search result set in a
  554. list format. Default: table format.
  555. Remarks:
  556. The dsget commands help you view the properties of a specific object in the directory:
  557. the input to dsget is an object and the output is a list of properties for that object.
  558. To find all objects that meet a given search criterion, use the dsquery commands
  559. (dsquery /?).
  560. If a value that you supply contains spaces, use quotation marks
  561. around the text (for example, "CN=John Smith,OU=Contacts,DC=microsoft,DC=com").
  562. If you enter multiple values, the values must be separated by spaces
  563. (for example, a list of distinguished names).
  564. Examples:
  565. To display the description and phone numbers for contacts
  566. "Jon Smith" and "Jona Jones".
  567. dsget contact "CN=John Doe,OU=Contacts,DC=microsoft,DC=com" "CN=Jane Doe,OU=Contacts,DC=microsoft,DC=com" -desc -tel
  568. See also:
  569. dsget - describes parameters that apply to all commands.
  570. dsget computer - displays properties of computers in the directory.
  571. dsget contact - displays properties of contacts in the directory.
  572. dsget subnet - displays properties of subnets in the directory.
  573. dsget group - displays properties of groups in the directory.
  574. dsget ou - displays properties of ou's in the directory.
  575. dsget server - displays properties of servers in the directory.
  576. dsget site - displays properties of sites in the directory.
  577. dsget user - displays properties of users in the directory.
  578. Directory Service command-line tools help:
  579. dsadd /? - help for adding objects.
  580. dsget /? - help for displaying objects.
  581. dsmod /? - help for modifying objects.
  582. dsmove /? - help for moving objects.
  583. dsquery /? - help for finding objects matching search criteria.
  584. dsrm /? - help for deleting objects.
  585. .
  586. MessageId=7
  587. SymbolicName=USAGE_DSGET_SUBNET
  588. Language=English
  589. Description: Displays properties of a subnet defined in the
  590. directory.
  591. Syntax: dsget subnet <Name ...>
  592. [-dn]
  593. [-desc]
  594. [-loc]
  595. [-site]
  596. [{-s <Server> | -d <Domain>}]
  597. [-u <UserName>]
  598. [-p {<Password> | *}]
  599. [-C]
  600. [-q]
  601. [-L]
  602. Parameters:
  603. Value Description
  604. <Name ...> Required/stdin. Common name (CN) of one or more subnets to view.
  605. -dn Displays the subnet distinguished name (DN).
  606. If the target objects are omitted they
  607. will be taken from standard input (stdin)
  608. to support piping of output from another
  609. command to input of this command.
  610. -desc Displays the subnet description.
  611. -loc Displays the subnet location.
  612. -site Displays the site name associated with the subnet.
  613. {-s <Server> | -d <Domain>}
  614. -s <Server> connects to the domain controller (DC)
  615. with name <Server>. Default: local system.
  616. -d <Domain> connects to a DC in domain <Domain>.
  617. Default: a DC in the logon domain.
  618. -u <UserName> Connect as <UserName>. Default: the logged in user.
  619. -p {<Password> | *}
  620. Password for the user <UserName>. If * then prompt for
  621. password.
  622. -C Continuous operation mode: report errors but continue
  623. with next object in argument list when multiple target
  624. objects are specified. Without this option, command
  625. exits on first error.
  626. -q Quiet mode: suppress all output to standard output.
  627. -L Displays the entries in the search result set in a
  628. list format. Default: table format.
  629. Remarks:
  630. The dsget commands help you view the properties of a specific object in the directory:
  631. the input to dsget is an object and the output is a list of properties for that object.
  632. To find all objects that meet a given search criterion, use the dsquery commands
  633. (dsquery /?).
  634. If a value that you supply contains spaces, use quotation marks
  635. around the text (for example, "123.56.15.0/24").
  636. If you enter multiple values, the values must be separated by spaces
  637. (for example, a list of subnet common names).
  638. Examples:
  639. To show all relevant properties for the subnets "123.56.15.0/24" and
  640. "123.56.16.0/24":
  641. dsget subnet "123.56.15.0/24" "123.56.16.0/24"
  642. See also:
  643. dsget - describes parameters that apply to all commands.
  644. dsget computer - displays properties of computers in the directory.
  645. dsget contact - displays properties of contacts in the directory.
  646. dsget subnet - displays properties of subnets in the directory.
  647. dsget group - displays properties of groups in the directory.
  648. dsget ou - displays properties of ou's in the directory.
  649. dsget server - displays properties of servers in the directory.
  650. dsget site - displays properties of sites in the directory.
  651. dsget user - displays properties of users in the directory.
  652. Directory Service command-line tools help:
  653. dsadd /? - help for adding objects.
  654. dsget /? - help for displaying objects.
  655. dsmod /? - help for modifying objects.
  656. dsmove /? - help for moving objects.
  657. dsquery /? - help for finding objects matching search criteria.
  658. dsrm /? - help for deleting objects.
  659. .
  660. MessageId=8
  661. SymbolicName=USAGE_DSGET_SITE
  662. Language=English
  663. Description: Display properties of a site defined in the directory.
  664. Syntax: dsget site <Name ...>
  665. [-dn]
  666. [-desc]
  667. [-autotopology]
  668. [-cachegroups]
  669. [-prefGCsite]
  670. [{-s <Server> | -d <Domain>}]
  671. [-u <UserName>]
  672. [-p {<Password> | *}]
  673. [-C]
  674. [-q]
  675. [-L]
  676. Parameters:
  677. Value Description
  678. <Name ...> Required/stdin. Common name (CN) of one or more sites to view.
  679. If the target objects are omitted they
  680. will be taken from standard input (stdin)
  681. to support piping of output from another
  682. command to input of this command.
  683. -dn Displays the site's distinguished name (DN).
  684. -desc Displays the site's description.
  685. -autotopology Displays if automatic inter-site topology generation
  686. is enabled (yes) or disabled (no).
  687. -cachegroups Displays if caching of group membership is enabled
  688. to support GC-less logon (yes) or disabled (no).
  689. -prefGCsite Displays the preferred GC site name if caching
  690. of groups is enabled.
  691. {-s <Server> | -d <Domain>}
  692. -s <Server> connects to the domain controller (DC)
  693. with name <Server>. Default: local system.
  694. -d <Domain> connects to a DC in domain <Domain>.
  695. Default: a DC in the logon domain.
  696. -u <UserName> Connect as <UserName>. Default: the logged in user.
  697. -p {<Password> | *}
  698. Password for the user <UserName>. If * then prompt for
  699. password.
  700. -C Continuous operation mode: report errors but continue
  701. with next object in argument list when multiple target
  702. objects are specified. Without this option, command
  703. exits on first error.
  704. -q Quiet mode: suppress all output to standard output.
  705. -L Displays the entries in the search result set in a
  706. list format. Default: table format.
  707. Remarks:
  708. The dsget commands help you view the properties of a specific object in the directory:
  709. the input to dsget is an object and the output is a list of properties for that object.
  710. To find all objects that meet a given search criterion, use the dsquery commands
  711. (dsquery /?).
  712. If a value that you supply contains spaces, use quotation marks
  713. around the text (for example, "CN=John Smith,CN=Users,DC=microsoft,DC=com").
  714. If you enter multiple values, the values must be separated by spaces
  715. (for example, a list of distinguished names).
  716. Examples:
  717. To find all sites in the forest and display their descriptions.
  718. dsquery site | dsget site -dn -desc
  719. See also:
  720. dsget - describes parameters that apply to all commands.
  721. dsget computer - displays properties of computers in the directory.
  722. dsget contact - displays properties of contacts in the directory.
  723. dsget subnet - displays properties of subnets in the directory.
  724. dsget group - displays properties of groups in the directory.
  725. dsget ou - displays properties of ou's in the directory.
  726. dsget server - displays properties of servers in the directory.
  727. dsget site - displays properties of sites in the directory.
  728. dsget user - displays properties of users in the directory.
  729. Directory Service command-line tools help:
  730. dsadd /? - help for adding objects.
  731. dsget /? - help for displaying objects.
  732. dsmod /? - help for modifying objects.
  733. dsmove /? - help for moving objects.
  734. dsquery /? - help for finding objects matching search criteria.
  735. dsrm /? - help for deleting objects.
  736. .
  737. MessageId=9
  738. SymbolicName=USAGE_DSGET_SLINK
  739. Language=English
  740. Description: Displays properties of a sitelink defined in the directory.
  741. Syntax: dsget slink <Name ...>
  742. [-transport {ip | smtp}]
  743. [-dn]
  744. [-desc]
  745. [-cost]
  746. [-replint]
  747. [-site]
  748. [-autobacksync]
  749. [-notify]
  750. [{-s <Server> | -d <Domain>}]
  751. [-u <UserName>]
  752. [-p {<Password> | *}]
  753. [-C]
  754. [-q]
  755. [-L]
  756. Parameters:
  757. Value Description
  758. <Name ...> Required/stdin. Common name of one or more sites to view.
  759. If the target objects are omitted they
  760. will be taken from standard input (stdin).
  761. -transport {ip | smtp} Inter-site transport type: IP or SMTP. Default: IP.
  762. All sitelinks given by <Name> or <ObjectDN> are treated
  763. to be of the same type.
  764. -dn Displays the sitelink distinguished name (DN).
  765. -desc Displays the sitelink description.
  766. -cost Displays the cost associated with the sitelink.
  767. -replint Displays the sitelink replication interval (minutes).
  768. -site Displays the list of site names linked by the sitelink.
  769. -autobacksync Displays if two-way sync option for the site link is
  770. enabled (Yes) or disabled (No).
  771. -notify Displays if notification by source on this link is enabled
  772. (Yes) or disabled (No).
  773. {-s <Server> | -d <Domain>}
  774. -s <Server> connects to the domain controller (DC)
  775. with name <Server>. Default: local system.
  776. -d <Domain> connects to a DC in domain <Domain>.
  777. Default: a DC in the logon domain.
  778. -u <UserName> Connect as <UserName>. Default: the logged in user.
  779. -p {<Password> | *} Password for the user <UserName>. If * then prompt for
  780. password.
  781. -C Continuous operation mode: report errors but continue
  782. with next object in argument list when multiple target
  783. objects are specified. Without this option, command
  784. exits on first error.
  785. -q Quiet mode: suppress all output to standard output.
  786. -L Displays the entries in the search result set in a
  787. list format. Default: table format.
  788. Remarks:
  789. The dsget commands help you view the properties of a specific object in the directory:
  790. the input to dsget is an object and the output is a list of properties for that object.
  791. To find all objects that meet a given search criterion, use the dsquery commands
  792. (dsquery /?).
  793. If a value that you supply contains spaces, use quotation marks
  794. around the text (for example, "CN=John Smith,CN=Users,DC=microsoft,DC=com").
  795. If you enter multiple values, the values must be separated by spaces
  796. (for example, a list of distinguished names).
  797. Examples:
  798. To find all SMTP sitelinks in the forest and display their associated sites.
  799. dsquery slink -transport smtp | dsget slink -dn -site
  800. See also:
  801. dsget - describes parameters that apply to all commands.
  802. dsget computer - displays properties of computers in the directory.
  803. dsget contact - displays properties of contacts in the directory.
  804. dsget subnet - displays properties of subnets in the directory.
  805. dsget group - displays properties of groups in the directory.
  806. dsget ou - displays properties of ou's in the directory.
  807. dsget server - displays properties of servers in the directory.
  808. dsget site - displays properties of sites in the directory.
  809. dsget user - displays properties of users in the directory.
  810. Directory Service command-line tools help:
  811. dsadd /? - help for adding objects.
  812. dsget /? - help for displaying objects.
  813. dsmod /? - help for modifying objects.
  814. dsmove /? - help for moving objects.
  815. dsquery /? - help for finding objects matching search criteria.
  816. dsrm /? - help for deleting objects.
  817. .
  818. MessageId=10
  819. SymbolicName=USAGE_DSGET_SLINKBR
  820. Language=English
  821. Description: dsget slinkbr displays properties of a sitelink bridge
  822. Syntax: dsadd slinkbr <Name ...>
  823. [-transport {ip | smtp}]
  824. [-desc <Description>]
  825. [-slink]
  826. [{-s <Server> | -d <Domain>}]
  827. [-u <UserName>]
  828. [-p {<Password> | *}]
  829. [-C]
  830. [-q]
  831. [-L]
  832. Parameters:
  833. Value Description
  834. <Name ...> Required/stdin. Common name of one or more
  835. sitelink bridges to view.
  836. If the target objects are omitted they
  837. will be taken from standard input (stdin).
  838. -transport {ip | smtp} Inter-site transport type: IP or SMTP. Default: IP.
  839. All site link bridges given by <Name> are
  840. treated to be of the same type.
  841. -dn Displays the site link bridge distinguished names (DN).
  842. -desc <Description> Displays the site link bridge description.
  843. -slink Displays the list of site links in the sitelink bridge.
  844. {-s <Server> | -d <Domain>}
  845. -s <Server> connects to the domain controller (DC)
  846. with name <Server>. Default: local system.
  847. -d <Domain> connects to a DC in domain <Domain>.
  848. Default: a DC in the logon domain.
  849. -u <UserName> Connect as <UserName>. Default: the logged in user.
  850. -p {<Password> | *} Password for the user <UserName>. If * then prompt for
  851. password.
  852. -C Continuous operation mode: report errors but continue
  853. with next object in argument list when multiple target
  854. objects are specified. Without this option, command
  855. exits on first error.
  856. -q Quiet mode: suppress all output to standard output.
  857. -L Displays the entries in the search result set in a
  858. list format. Default: table format.
  859. Remarks:
  860. The dsget commands help you view the properties of a specific object in the directory:
  861. the input to dsget is an object and the output is a list of properties for that object.
  862. To find all objects that meet a given search criterion, use the dsquery commands
  863. (dsquery /?).
  864. If a value that you supply contains spaces, use quotation marks
  865. around the text (for example, "CN=John Smith,CN=Users,DC=microsoft,DC=com").
  866. If you enter multiple values, the values must be separated by spaces
  867. (for example, a list of distinguished names).
  868. Examples:
  869. To find all SMTP sitelink bridges in the forest and display their associated site
  870. links.
  871. dsquery slinkbr -transport smtp | dsget slinkbr -dn -slink
  872. See also:
  873. dsget - describes parameters that apply to all commands.
  874. dsget computer - displays properties of computers in the directory.
  875. dsget contact - displays properties of contacts in the directory.
  876. dsget subnet - displays properties of subnets in the directory.
  877. dsget group - displays properties of groups in the directory.
  878. dsget ou - displays properties of ou's in the directory.
  879. dsget server - displays properties of servers in the directory.
  880. dsget site - displays properties of sites in the directory.
  881. dsget user - displays properties of users in the directory.
  882. Directory Service command-line tools help:
  883. dsadd /? - help for adding objects.
  884. dsget /? - help for displaying objects.
  885. dsmod /? - help for modifying objects.
  886. dsmove /? - help for moving objects.
  887. dsquery /? - help for finding objects matching search criteria.
  888. dsrm /? - help for deleting objects.
  889. .
  890. MessageId=11
  891. SymbolicName=USAGE_DSGET_CONN
  892. Language=English
  893. Description: Displays properties of a replication connection.
  894. Syntax: dsget conn <ObjectDN ...>
  895. [-dn]
  896. [-desc]
  897. [-from]
  898. [-transport]
  899. [-enabled]
  900. [-manual]
  901. [-autobacksync]
  902. [-notify]
  903. [{-s <Server> | -d <Domain>}]
  904. [-u <UserName>]
  905. [-p {<Password> | *}]
  906. [-C]
  907. [-q]
  908. [-L]
  909. Parameters:
  910. Value Description
  911. <ObjectDN ...> Required/stdin. Distinguished names (DNs) of one
  912. or more connections to view.
  913. If the target objects are omitted they
  914. will be taken from standard input (stdin).
  915. -dn Show the connection DN.
  916. -desc Show the connection description.
  917. -from Show the server name at the from-end of connection.
  918. -transport Show the transport type (rpc, ip, smtp) of connection.
  919. -enabled Show if the connection is enabled.
  920. -manual Show if the connection is under manual control (yes) or
  921. under automatic KCC control (no).
  922. -autobacksync Show if automatic two-way sync for the connection is
  923. enabled (yes) or disabled (no).
  924. -notify Show if notification by source for the connection is
  925. enabled (yes), disabled (no) or set to default behavior.
  926. {-s <Server> | -d <Domain>}
  927. -s <Server> connects to the domain controller (DC)
  928. with name <Server>. Default: local system.
  929. -d <Domain> connects to a DC in domain <Domain>.
  930. Default: a DC in the logon domain.
  931. -u <UserName> Connect as <UserName>. Default: the logged in user.
  932. -p {<Password> | *}
  933. Password for the user <UserName>. If * then prompt for
  934. password.
  935. -C Continuous operation mode: report errors but continue
  936. with next object in argument list when multiple target
  937. objects are specified. Without this option, command
  938. exits on first error.
  939. -q Quiet mode: suppress all output to standard output.
  940. -L Displays the entries in the search result set in a
  941. list format. Default: table format.
  942. Remarks:
  943. The dsget commands help you view the properties of a specific object in the directory:
  944. the input to dsget is an object and the output is a list of properties for that object.
  945. To find all objects that meet a given search criterion, use the dsquery commands
  946. (dsquery /?).
  947. If a value that you supply contains spaces, use quotation marks
  948. around the text (for example, "CN=John Smith,CN=Users,DC=microsoft,DC=com").
  949. If you enter multiple values, the values must be separated by spaces
  950. (for example, a list of distinguished names).
  951. Examples:
  952. To find all connections for server CORPDC1 and show their from-end servers and
  953. enabled states.
  954. dsquery conn -to CORPDC1 | dsget conn -dn -from -enabled
  955. See also:
  956. dsget - describes parameters that apply to all commands.
  957. dsget computer - displays properties of computers in the directory.
  958. dsget contact - displays properties of contacts in the directory.
  959. dsget subnet - displays properties of subnets in the directory.
  960. dsget group - displays properties of groups in the directory.
  961. dsget ou - displays properties of ou's in the directory.
  962. dsget server - displays properties of servers in the directory.
  963. dsget site - displays properties of sites in the directory.
  964. dsget user - displays properties of users in the directory.
  965. Directory Service command-line tools help:
  966. dsadd /? - help for adding objects.
  967. dsget /? - help for displaying objects.
  968. dsmod /? - help for modifying objects.
  969. dsmove /? - help for moving objects.
  970. dsquery /? - help for finding objects matching search criteria.
  971. dsrm /? - help for deleting objects.
  972. .
  973. MessageId=12
  974. SymbolicName=USAGE_DSGET_SERVER
  975. Language=English
  976. Description: Displays properties of a domain controller.
  977. Syntax: dsget server <ObjectDN ...>
  978. [-dn]
  979. [-desc]
  980. [-dnsname]
  981. [-site]
  982. [-isgc]
  983. [{-s <Server> | -d <Domain>}]
  984. [-u <UserName>]
  985. [-p {<Password> | *}]
  986. [-C]
  987. [-q]
  988. [-L]
  989. Parameters:
  990. Value Description
  991. <ObjectDN ...> Required/stdin. Distinguished names (DNs) of one
  992. or more servers to view.
  993. If the target objects are omitted they
  994. will be taken from standard input (stdin)
  995. to support piping of output from another
  996. command to input of this command.
  997. -dn Displays the server's DN.
  998. -desc Displays the server's description.
  999. -dnsname Displays the server's Domain Name System (DNS) host name.
  1000. -site Displays the site to which this server belongs.
  1001. -isgc Displays whether or not the server is a global catalog server.
  1002. {-s <Server> | -d <Domain>}
  1003. -s <Server> connects to the domain controller (DC)
  1004. with name <Server>. Default: local system.
  1005. -d <Domain> connects to a DC in domain <Domain>.
  1006. Default: a DC in the logon domain.
  1007. -u <UserName> Connect as <UserName>. Default: the logged in user.
  1008. -p {<Password> | *}
  1009. Password for the user <UserName>. If * then prompt for
  1010. password.
  1011. -C Continuous operation mode: report errors but continue
  1012. with next object in argument list when multiple target
  1013. objects are specified. Without this option, command
  1014. exits on first error.
  1015. -q Quiet mode: suppress all output to standard output.
  1016. -L Displays the entries in the search result set in a
  1017. list format. Default: table format.
  1018. Remarks:
  1019. The dsget commands help you view the properties of a specific object in the directory:
  1020. the input to dsget is an object and the output is a list of properties for that object.
  1021. To find all objects that meet a given search criterion, use the dsquery commands
  1022. (dsquery /?).
  1023. If a value that you supply contains spaces, use quotation marks
  1024. around the text (for example, "CN=My Server,CN=Servers,CN=Site10,
  1025. CN=Sites,CN=Configuration,DC=microsoft,DC=com").
  1026. If you enter multiple values, the values must be separated by spaces
  1027. (for example, a list of distinguished names).
  1028. Examples:
  1029. To find all domain controllers for domain corp.microsoft.com and display their DNS host
  1030. name and site name.
  1031. dsquery server -domain corp.microsoft.com |
  1032. dsget server -dnsname -site
  1033. To show if a domain controller with name DC1 is also a global catalog server:
  1034. dsget server
  1035. cn=DC1,cn=Servers,cn=Site10,cn=Sites,cn=Configuration,dc=microsoft,dc=com
  1036. -isgc
  1037. See also:
  1038. dsget - describes parameters that apply to all commands.
  1039. dsget computer - displays properties of computers in the directory.
  1040. dsget contact - displays properties of contacts in the directory.
  1041. dsget subnet - displays properties of subnets in the directory.
  1042. dsget group - displays properties of groups in the directory.
  1043. dsget ou - displays properties of ou's in the directory.
  1044. dsget server - displays properties of servers in the directory.
  1045. dsget site - displays properties of sites in the directory.
  1046. dsget user - displays properties of users in the directory.
  1047. Directory Service command-line tools help:
  1048. dsadd /? - help for adding objects.
  1049. dsget /? - help for displaying objects.
  1050. dsmod /? - help for modifying objects.
  1051. dsmove /? - help for moving objects.
  1052. dsquery /? - help for finding objects matching search criteria.
  1053. dsrm /? - help for deleting objects.
  1054. .
  1055.