PageRenderTime 61ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 1ms

/Source/Quest.FIMPowerShellSnapin.dll-Help.xml

#
XML | 1411 lines | 1349 code | 42 blank | 20 comment | 0 complexity | 797b346ccb9b7089bed5c7ba443a2b63 MD5 | raw file
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <helpItems xmlns="http://msh" schema="maml">
  3. <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
  4. <!--Generated by Help Cmdlet Editor-->
  5. <command:details>
  6. <command:name>Get-FIMResource</command:name>
  7. <maml:description>
  8. <maml:para>The Get-FIMResource cmdlet returns one or more FIMResource objects that exist in the FIM web service database.</maml:para>
  9. </maml:description>
  10. <maml:copyright>
  11. <maml:para />
  12. <!--Add copy right info here.-->
  13. </maml:copyright>
  14. <command:verb>Get</command:verb>
  15. <command:noun>FIMResource</command:noun>
  16. <!--Add Dev version info here.-->
  17. <dev:version />
  18. </command:details>
  19. <maml:description>
  20. <!--This is the Description section-->
  21. <maml:para>This cmdlet is used to retrieve a single FIMResource or search and retrieve multiple FIMResources from the FIM web service.</maml:para>
  22. </maml:description>
  23. <command:syntax> <command:syntaxItem>
  24. <maml:name>Get-FIMResource</maml:name>
  25. <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "1" >
  26. <maml:name>ObjectID</maml:name>
  27. <maml:description>
  28. <maml:para>The ObjectID parameter is used to specify the FIM resource to retrieve.</maml:para>
  29. </maml:description>
  30. <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue>
  31. </command:parameter>
  32. <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" >
  33. <maml:name>Attributes</maml:name>
  34. <maml:description>
  35. <maml:para>This parameter specifies which attributes of the Resource to fetch, in addition to the default attributes bound to the base FIMResource type.
  36. - Specify a comma separated list of attribute names (SystemNames of the corresponding AttributeTypeDescription).
  37. - If the value 'All' is provided as the value for this parameter, then all the attributes (all attributes of the Resource, from the Resources schema) would be fetched.</maml:para>
  38. </maml:description>
  39. <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue>
  40. </command:parameter>
  41. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  42. <maml:name>Locale</maml:name>
  43. <maml:description>
  44. <maml:para>This parameter specifies the localized version of the FIMResource to get. All attributes on the FIMResource that exist in the specified locale are returned in their localized form. Attributes that do not exist in the specified locale are returned in their culture invariant locale.
  45. The Locale is specified by the Culture Name associated with the locale.
  46. E.g. Locale en-GB specifies that the English UK representation of the object should be returned.</maml:para>
  47. </maml:description>
  48. <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue>
  49. </command:parameter>
  50. <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" >
  51. <maml:name>Session</maml:name>
  52. <maml:description>
  53. <maml:para>Specifies FIMSession object to be used to establish a session with a specific FIM web service, using specific credentials.</maml:para>
  54. </maml:description>
  55. <command:parameterValue required="true" variableLength = "false" >FIMSession</command:parameterValue>
  56. </command:parameter>
  57. </command:syntaxItem>
  58. <command:syntaxItem>
  59. <maml:name>Get-FIMResource</maml:name>
  60. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  61. <maml:name>Filter</maml:name>
  62. <maml:description>
  63. <maml:para>This parameter specifies a filter in the XPath Filter Dialect supported by FIM. This filter restricts the objects that are returned by the cmdlet to only those objects that meet the specified filter.</maml:para>
  64. </maml:description>
  65. <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue>
  66. </command:parameter>
  67. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  68. <maml:name>ResultSetSize</maml:name>
  69. <maml:description>
  70. <maml:para>Specify the size of the result set to be fetched, through this parameter. By default at most 1000 Resources will be fetched. A 0 value signifies &quot;No Limit&quot;.</maml:para>
  71. </maml:description>
  72. <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue>
  73. </command:parameter>
  74. <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" >
  75. <maml:name>Attributes</maml:name>
  76. <maml:description>
  77. <maml:para>This parameter specifies which attributes of the Resource to fetch, in addition to the default attributes bound to the base FIMResource type.
  78. - Specify a comma separated list of attribute names (SystemNames of the corresponding AttributeTypeDescription).
  79. - If the value 'All' is provided as the value for this parameter, then all the attributes (all attributes of the Resource, from the Resources schema) would be fetched.</maml:para>
  80. </maml:description>
  81. <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue>
  82. </command:parameter>
  83. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  84. <maml:name>SnapshotTime</maml:name>
  85. <maml:description>
  86. <maml:para>This parameter specifies a DateTime for which to retrieve the representation of a Resource. The Resource identified by the ObjectID or Filter specified will be returned in its representation at the DateTime specified here.</maml:para>
  87. </maml:description>
  88. <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue>
  89. </command:parameter>
  90. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  91. <maml:name>Locale</maml:name>
  92. <maml:description>
  93. <maml:para>This parameter specifies the localized version of the Resource to get. All attributes on the Resource that exist in the specified locale are returned in their localized form. Attributes that do not exist in the specified locale are returned in their culture invariant locale.
  94. The Locale is specified by the Culture Name associated with the locale.
  95. E.g. Locale en-GB specifies that the English UK representation of the object should be returned.</maml:para>
  96. </maml:description>
  97. <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue>
  98. </command:parameter>
  99. <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" >
  100. <maml:name>Session</maml:name>
  101. <maml:description>
  102. <maml:para>Specifies the FIMSession object to be used to establish a session with a specific FIM web service, using specific credentials.</maml:para>
  103. </maml:description>
  104. <command:parameterValue required="true" variableLength = "false" >FIMSession</command:parameterValue>
  105. </command:parameter>
  106. </command:syntaxItem>
  107. </command:syntax>
  108. <command:parameters>
  109. <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1">
  110. <maml:name>ObjectID</maml:name>
  111. <maml:description>
  112. <maml:para>The ObjectID parameter is used to specify the FIMResource to retrieve.</maml:para>
  113. </maml:description>
  114. <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
  115. <dev:type>
  116. <maml:name>String</maml:name>
  117. <maml:uri/>
  118. </dev:type>
  119. <dev:defaultValue></dev:defaultValue>
  120. </command:parameter>
  121. <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
  122. <maml:name>Attributes</maml:name>
  123. <maml:description>
  124. <maml:para>This parameter specifies which attributes of the Resource to fetch, in addition to the default attributes bound to the base FIMResource type.
  125. - Specify a comma separated list of attribute names (SystemNames of the corresponding AttributeTypeDescription).
  126. - If the value 'All' is provided as the value for this parameter, then all the attributes (all attributes of the Resource, from the Resources schema) would be fetched.</maml:para>
  127. </maml:description>
  128. <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue>
  129. <dev:type>
  130. <maml:name>String[]</maml:name>
  131. <maml:uri/>
  132. </dev:type>
  133. <dev:defaultValue></dev:defaultValue>
  134. </command:parameter>
  135. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  136. <maml:name>Locale</maml:name>
  137. <maml:description>
  138. <maml:para>This parameter specifies the localized version of the Resource to get. All attributes on the Resource that exist in the specified locale are returned in their localized form. Attributes that do not exist in the specified locale are returned in their culture invariant locale.
  139. The Locale is specified by the Culture Name associated with the locale.
  140. E.g. Locale en-GB specifies that the English UK representation of the object should be returned.</maml:para>
  141. </maml:description>
  142. <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
  143. <dev:type>
  144. <maml:name>String</maml:name>
  145. <maml:uri/>
  146. </dev:type>
  147. <dev:defaultValue></dev:defaultValue>
  148. </command:parameter>
  149. <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named">
  150. <maml:name>Session</maml:name>
  151. <maml:description>
  152. <maml:para>Specifies FIMSession object to be used to establish a session with a specific FIM web service, under specific credentials.</maml:para>
  153. </maml:description>
  154. <command:parameterValue required="true" variableLength="false">FIMSession</command:parameterValue>
  155. <dev:type>
  156. <maml:name>FIMSession</maml:name>
  157. <maml:uri/>
  158. </dev:type>
  159. <dev:defaultValue></dev:defaultValue>
  160. </command:parameter>
  161. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  162. <maml:name>Filter</maml:name>
  163. <maml:description>
  164. <maml:para>This parameter specifies a filter in the XPath Filter Dialect supported by FIM. This filter restricts the objects that are returned by the cmdlet to only those objects that meet the specified filter.</maml:para>
  165. </maml:description>
  166. <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
  167. <dev:type>
  168. <maml:name>String</maml:name>
  169. <maml:uri/>
  170. </dev:type>
  171. <dev:defaultValue></dev:defaultValue>
  172. </command:parameter>
  173. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  174. <maml:name>ResultSetSize</maml:name>
  175. <maml:description>
  176. <maml:para>Specify the size of the result set to be fetched, through this parameter. By default at most 1000 Resources will be fetched. A 0 value signifies &quot;No Limit&quot;.</maml:para>
  177. </maml:description>
  178. <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
  179. <dev:type>
  180. <maml:name>Int32</maml:name>
  181. <maml:uri/>
  182. </dev:type>
  183. <dev:defaultValue></dev:defaultValue>
  184. </command:parameter>
  185. </command:parameters>
  186. <command:inputTypes>
  187. <command:inputType>
  188. <dev:type>
  189. <maml:name></maml:name>
  190. <maml:uri/>
  191. <maml:description>
  192. <maml:para></maml:para>
  193. </maml:description>
  194. </dev:type>
  195. <maml:description></maml:description>
  196. </command:inputType>
  197. </command:inputTypes>
  198. <command:returnValues>
  199. <command:returnValue>
  200. <dev:type>
  201. <maml:name></maml:name>
  202. <maml:uri />
  203. <maml:description>
  204. <maml:para></maml:para>
  205. </maml:description>
  206. </dev:type>
  207. <maml:description></maml:description>
  208. </command:returnValue>
  209. </command:returnValues>
  210. <command:terminatingErrors>
  211. </command:terminatingErrors>
  212. <command:nonTerminatingErrors>
  213. </command:nonTerminatingErrors>
  214. <maml:alertSet>
  215. <maml:title></maml:title>
  216. <maml:alert>
  217. <maml:para></maml:para>
  218. </maml:alert>
  219. </maml:alertSet>
  220. <command:examples>
  221. <command:example>
  222. <maml:title>
  223. -------------- EXAMPLE 1 -------------- </maml:title>
  224. <maml:introduction>
  225. <maml:para>C:\PS&gt;</maml:para>
  226. C:\PS&gt; </maml:introduction>
  227. <dev:code>$session = New-FIMSession -Server &quot;fimserver.domain.local&quot;
  228. Get-FIMResource -Filter &quot;/group&quot; -Session $session</dev:code>
  229. <dev:remarks>
  230. <maml:para>These commands list all groups in FIM web service.</maml:para>
  231. <maml:para></maml:para>
  232. <maml:para></maml:para>
  233. <maml:para>
  234. </maml:para>
  235. <maml:para></maml:para>
  236. </dev:remarks>
  237. <command:commandLines>
  238. <command:commandLine>
  239. <command:commandText>
  240. </command:commandText>
  241. </command:commandLine>
  242. </command:commandLines>
  243. </command:example>
  244. <command:example>
  245. <maml:title>
  246. -------------- EXAMPLE 2 -------------- </maml:title>
  247. <maml:introduction>
  248. <maml:para>C:\PS&gt;</maml:para>
  249. C:\PS&gt; </maml:introduction>
  250. <dev:code>$session = New-FIMSession -Server &quot;fimserver.domain.local&quot;
  251. $user = Get-FIMResource -Filter &quot;/person[DisplayName='Some User']&quot; -Session $session -Attributes &quot;All&quot; -Locale &quot;en-US&quot; -ResultSetSize 1
  252. foreach ($attr in $user.Attributes) { $attr.Name + &quot; : &quot; + $user[$attr.Name] }</dev:code>
  253. <dev:remarks>
  254. <maml:para>These commands retrieve all attributes of one user with specified display name. Attributes are requested in a specific locale.</maml:para>
  255. <maml:para></maml:para>
  256. <maml:para></maml:para>
  257. <maml:para>
  258. </maml:para>
  259. <maml:para></maml:para>
  260. </dev:remarks>
  261. <command:commandLines>
  262. <command:commandLine>
  263. <command:commandText>
  264. </command:commandText>
  265. </command:commandLine>
  266. </command:commandLines>
  267. </command:example>
  268. <command:example>
  269. <maml:title>
  270. -------------- EXAMPLE 3 -------------- </maml:title>
  271. <maml:introduction>
  272. <maml:para>C:\PS&gt;</maml:para>
  273. C:\PS&gt; </maml:introduction>
  274. <dev:code>$session = New-FIMSession -Server &quot;fimserver.domain.local&quot;
  275. $user = Get-FIMResource -Filter &quot;/person[DisplayName='Some User']&quot; -Session $session -Attributes &quot;MobilePhone&quot;
  276. &quot;New phone: &quot; + $user[&quot;MobilePhone&quot;]
  277. $user = Get-FIMResource -ObjectID $user.ObjectID -Session $session -SnapshotTime $user[&quot;CreatedTime&quot;] -Attributes &quot;MobilePhone&quot;
  278. &quot;Old phone: &quot; + $user[&quot;MobilePhone&quot;]</dev:code>
  279. <dev:remarks>
  280. <maml:para>These commands display up-to-date mobile phone number of specific user and mobile phone number that user had when his or her account was created.</maml:para>
  281. <maml:para></maml:para>
  282. <maml:para></maml:para>
  283. <maml:para>
  284. </maml:para>
  285. <maml:para></maml:para>
  286. </dev:remarks>
  287. <command:commandLines>
  288. <command:commandLine>
  289. <command:commandText>
  290. </command:commandText>
  291. </command:commandLine>
  292. </command:commandLines>
  293. </command:example>
  294. <command:example>
  295. <maml:title>
  296. -------------- EXAMPLE 4 -------------- </maml:title>
  297. <maml:introduction>
  298. <maml:para>C:\PS&gt;</maml:para>
  299. C:\PS&gt; </maml:introduction>
  300. <dev:code>$s = New-FIMSession -Server &quot;fimserver.domain.local&quot;
  301. $s | Get-FIMResource -f &quot;/BindingDescription[BoundObjectType=/ObjectTypeDescription[DisplayName='User']]/BoundAttributeType&quot; -a Name | %{$_[&quot;Name&quot;]} | Sort-Object</dev:code>
  302. <dev:remarks>
  303. <maml:para>These commands list all possible attributes for object type 'User' in alphabetical order.</maml:para>
  304. <maml:para></maml:para>
  305. <maml:para></maml:para>
  306. <maml:para>
  307. </maml:para>
  308. <maml:para></maml:para>
  309. </dev:remarks>
  310. <command:commandLines>
  311. <command:commandLine>
  312. <command:commandText>
  313. </command:commandText>
  314. </command:commandLine>
  315. </command:commandLines>
  316. </command:example>
  317. <command:example>
  318. <maml:title>
  319. -------------- EXAMPLE 5 -------------- </maml:title>
  320. <maml:introduction>
  321. <maml:para>C:\PS&gt;</maml:para>
  322. C:\PS&gt; </maml:introduction>
  323. <dev:code>$session = New-FIMSession -Server &quot;fimserver.domain.local&quot;
  324. $user = New-FIMResource -Type &quot;Person&quot; -Session $session -Attributes @{&quot;DisplayName&quot;=&quot;Thomas Anderson&quot;; &quot;AccountName&quot;=&quot;neo&quot;} -PassThru
  325. $user = $user | Get-FIMResource -Attributes &quot;All&quot;</dev:code>
  326. <dev:remarks>
  327. <maml:para>The last command updates FIMResource $user with all actual attribute values.</maml:para>
  328. <maml:para></maml:para>
  329. <maml:para></maml:para>
  330. <maml:para>
  331. </maml:para>
  332. <maml:para></maml:para>
  333. </dev:remarks>
  334. <command:commandLines>
  335. <command:commandLine>
  336. <command:commandText>
  337. </command:commandText>
  338. </command:commandLine>
  339. </command:commandLines>
  340. </command:example>
  341. </command:examples>
  342. <maml:relatedLinks>
  343. </maml:relatedLinks>
  344. </command:command>
  345. <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
  346. <!--Generated by Help Cmdlet Editor-->
  347. <command:details>
  348. <command:name>New-FIMResource</command:name>
  349. <maml:description>
  350. <maml:para>The New-FIMResource cmdlet creates a new object in the FIM web service database.</maml:para>
  351. </maml:description>
  352. <maml:copyright>
  353. <maml:para />
  354. <!--Add copy right info here.-->
  355. </maml:copyright>
  356. <command:verb>New</command:verb>
  357. <command:noun>FIMResource</command:noun>
  358. <!--Add Dev version info here.-->
  359. <dev:version />
  360. </command:details>
  361. <maml:description>
  362. <!--This is the Description section-->
  363. <maml:para>The New-FIMResource cmdlet creates a new object in the FIM web service database.</maml:para>
  364. </maml:description>
  365. <command:syntax> <command:syntaxItem>
  366. <maml:name>New-FIMResource</maml:name>
  367. <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" >
  368. <maml:name>Type</maml:name>
  369. <maml:description>
  370. <maml:para>This parameter specifies the object type that is being created. If the specified object type does not exist, an error will be returned indicating this.</maml:para>
  371. </maml:description>
  372. <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue>
  373. </command:parameter>
  374. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" >
  375. <maml:name>Attributes</maml:name>
  376. <maml:description>
  377. <maml:para>This parameter is used to specify other attributes of the Resource to initialize. Depending on the object type, the required attributes must be specified using this parameter.</maml:para>
  378. </maml:description>
  379. <command:parameterValue required="true" variableLength = "false" >Hashtable</command:parameterValue>
  380. </command:parameter>
  381. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  382. <maml:name>PassThru</maml:name>
  383. <maml:description>
  384. <maml:para>Passes through the pipeline an object containing the ObjectID of the created object with all attributes passed to this cmdlet. By default, this cmdlet does not pass any objects through the pipeline.</maml:para>
  385. </maml:description>
  386. </command:parameter>
  387. <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" >
  388. <maml:name>Session</maml:name>
  389. <maml:description>
  390. <maml:para>Specifies the FIMSession object to be used to establish a session with a specific FIM web service, using specific credentials.</maml:para>
  391. </maml:description>
  392. <command:parameterValue required="true" variableLength = "false" >FIMSession</command:parameterValue>
  393. </command:parameter>
  394. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  395. <maml:name>WhatIf</maml:name>
  396. <maml:description>
  397. <maml:para>Describes what would happen if you executed the command, without actually executing the command.</maml:para>
  398. </maml:description>
  399. </command:parameter>
  400. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  401. <maml:name>Confirm</maml:name>
  402. <maml:description>
  403. <maml:para>Prompts you for confirmation before executing the command.</maml:para>
  404. </maml:description>
  405. </command:parameter>
  406. </command:syntaxItem>
  407. <command:syntaxItem>
  408. <maml:name>New-FIMResource</maml:name>
  409. <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue)" position = "named" >
  410. <maml:name>Instance</maml:name>
  411. <maml:description>
  412. <maml:para>Specifies the FIMResource instance all attributes of which will be sent to FIM web servoce in an object creation request.</maml:para>
  413. </maml:description>
  414. <command:parameterValue required="true" variableLength = "false" >FIMResource</command:parameterValue>
  415. </command:parameter>
  416. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" >
  417. <maml:name>Attributes</maml:name>
  418. <maml:description>
  419. <maml:para>This parameter is used to specify other attributes of the Resource to initialize. Depending on the object type, the required attributes must be specified using this parameter.</maml:para>
  420. </maml:description>
  421. <command:parameterValue required="true" variableLength = "false" >Hashtable</command:parameterValue>
  422. </command:parameter>
  423. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  424. <maml:name>PassThru</maml:name>
  425. <maml:description>
  426. <maml:para>Passes through the pipeline an object containing the ObjectID of the created object with all attributes passed to this cmdlet. By default, this cmdlet does not pass any objects through the pipeline.</maml:para>
  427. </maml:description>
  428. </command:parameter>
  429. <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" >
  430. <maml:name>Session</maml:name>
  431. <maml:description>
  432. <maml:para>Specifies FIMSession object to be used to establish a session with a specific FIM server, using specific credentials.</maml:para>
  433. </maml:description>
  434. <command:parameterValue required="true" variableLength = "false" >FIMSession</command:parameterValue>
  435. </command:parameter>
  436. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  437. <maml:name>WhatIf</maml:name>
  438. <maml:description>
  439. <maml:para>Describes what would happen if you executed the command, without actually executing the command.</maml:para>
  440. </maml:description>
  441. </command:parameter>
  442. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  443. <maml:name>Confirm</maml:name>
  444. <maml:description>
  445. <maml:para>Prompts you for confirmation before executing the command.</maml:para>
  446. </maml:description>
  447. </command:parameter>
  448. </command:syntaxItem>
  449. </command:syntax>
  450. <command:parameters>
  451. <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
  452. <maml:name>Type</maml:name>
  453. <maml:description>
  454. <maml:para>This parameter specifies the object type that is being created. If the specified object type does not exist, an error will be returned indicating this.</maml:para>
  455. </maml:description>
  456. <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
  457. <dev:type>
  458. <maml:name>String</maml:name>
  459. <maml:uri/>
  460. </dev:type>
  461. <dev:defaultValue></dev:defaultValue>
  462. </command:parameter>
  463. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
  464. <maml:name>Attributes</maml:name>
  465. <maml:description>
  466. <maml:para>This parameter is used to specify other attributes of the Resource to initialize. Depending on the object type, the required attributes must be specified using this parameter.</maml:para>
  467. </maml:description>
  468. <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue>
  469. <dev:type>
  470. <maml:name>Hashtable</maml:name>
  471. <maml:uri/>
  472. </dev:type>
  473. <dev:defaultValue></dev:defaultValue>
  474. </command:parameter>
  475. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  476. <maml:name>PassThru</maml:name>
  477. <maml:description>
  478. <maml:para>Passes through the pipeline an object containing the ObjectID of the created object with all attributes passed to this cmdlet. By default, this cmdlet does not pass any objects through the pipeline.</maml:para>
  479. </maml:description>
  480. <dev:type>
  481. <maml:name>SwitchParameter</maml:name>
  482. <maml:uri/>
  483. </dev:type>
  484. <dev:defaultValue></dev:defaultValue>
  485. </command:parameter>
  486. <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named">
  487. <maml:name>Session</maml:name>
  488. <maml:description>
  489. <maml:para>Specifies FIMSession object to be used to establish a session with a specific FIM web service, using specific credentials.</maml:para>
  490. </maml:description>
  491. <command:parameterValue required="true" variableLength="false">FIMSession</command:parameterValue>
  492. <dev:type>
  493. <maml:name>FIMSession</maml:name>
  494. <maml:uri/>
  495. </dev:type>
  496. <dev:defaultValue></dev:defaultValue>
  497. </command:parameter>
  498. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  499. <maml:name>WhatIf</maml:name>
  500. <maml:description>
  501. <maml:para>Describes what would happen if you executed the command, without actually executing the command.</maml:para>
  502. </maml:description>
  503. <dev:type>
  504. <maml:name>SwitchParameter</maml:name>
  505. <maml:uri/>
  506. </dev:type>
  507. <dev:defaultValue></dev:defaultValue>
  508. </command:parameter>
  509. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  510. <maml:name>Confirm</maml:name>
  511. <maml:description>
  512. <maml:para>Prompts you for confirmation before executing the command.</maml:para>
  513. </maml:description>
  514. <dev:type>
  515. <maml:name>SwitchParameter</maml:name>
  516. <maml:uri/>
  517. </dev:type>
  518. <dev:defaultValue></dev:defaultValue>
  519. </command:parameter>
  520. <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named">
  521. <maml:name>Instance</maml:name>
  522. <maml:description>
  523. <maml:para>Specifies the FIMResource instance all attributes of which will be sent to FIM web service in an object creation request.</maml:para>
  524. </maml:description>
  525. <command:parameterValue required="true" variableLength="false">FIMResource</command:parameterValue>
  526. <dev:type>
  527. <maml:name>FIMResource</maml:name>
  528. <maml:uri/>
  529. </dev:type>
  530. <dev:defaultValue></dev:defaultValue>
  531. </command:parameter>
  532. </command:parameters>
  533. <command:inputTypes>
  534. <command:inputType>
  535. <dev:type>
  536. <maml:name></maml:name>
  537. <maml:uri/>
  538. <maml:description>
  539. <maml:para></maml:para>
  540. </maml:description>
  541. </dev:type>
  542. <maml:description></maml:description>
  543. </command:inputType>
  544. </command:inputTypes>
  545. <command:returnValues>
  546. <command:returnValue>
  547. <dev:type>
  548. <maml:name></maml:name>
  549. <maml:uri />
  550. <maml:description>
  551. <maml:para></maml:para>
  552. </maml:description>
  553. </dev:type>
  554. <maml:description></maml:description>
  555. </command:returnValue>
  556. </command:returnValues>
  557. <command:terminatingErrors>
  558. </command:terminatingErrors>
  559. <command:nonTerminatingErrors>
  560. </command:nonTerminatingErrors>
  561. <maml:alertSet>
  562. <maml:title></maml:title>
  563. <maml:alert>
  564. <maml:para></maml:para>
  565. </maml:alert>
  566. </maml:alertSet>
  567. <command:examples>
  568. <command:example>
  569. <maml:title>
  570. -------------- EXAMPLE 1 -------------- </maml:title>
  571. <maml:introduction>
  572. <maml:para>C:\PS&gt;</maml:para>
  573. C:\PS&gt; </maml:introduction>
  574. <dev:code>$session = New-FIMSession -Server &quot;fimserver.domain.local&quot;
  575. New-FIMResource -Type &quot;Person&quot; -Session $session -Attributes @{&quot;DisplayName&quot;=&quot;Thomas Anderson&quot;; &quot;AccountName&quot;=&quot;neo&quot;}</dev:code>
  576. <dev:remarks>
  577. <maml:para>These commands create a new user with specified values of some attributes.</maml:para>
  578. <maml:para></maml:para>
  579. <maml:para></maml:para>
  580. <maml:para>
  581. </maml:para>
  582. <maml:para></maml:para>
  583. </dev:remarks>
  584. <command:commandLines>
  585. <command:commandLine>
  586. <command:commandText>
  587. </command:commandText>
  588. </command:commandLine>
  589. </command:commandLines>
  590. </command:example>
  591. <command:example>
  592. <maml:title>
  593. -------------- EXAMPLE 2 -------------- </maml:title>
  594. <maml:introduction>
  595. <maml:para>C:\PS&gt;</maml:para>
  596. C:\PS&gt; </maml:introduction>
  597. <dev:code>$session = New-FIMSession -Server &quot;fimserver.domain.local&quot;
  598. $user = New-Object Quest.FIMPowerShellSnapin.FIMResource($session)
  599. $user.SetValue(&quot;ObjectType&quot;, &quot;Person&quot;)
  600. $user.SetValue(&quot;DisplayName&quot;, &quot;Agent Smith&quot;)
  601. $user.SetValue(&quot;AccountName&quot;, &quot;smith&quot;)
  602. $user | New-FIMResource</dev:code>
  603. <dev:remarks>
  604. <maml:para>These commands create a user by first creating an FIMResource representation for desired set of attributes.</maml:para>
  605. <maml:para></maml:para>
  606. <maml:para></maml:para>
  607. <maml:para>
  608. </maml:para>
  609. <maml:para></maml:para>
  610. </dev:remarks>
  611. <command:commandLines>
  612. <command:commandLine>
  613. <command:commandText>
  614. </command:commandText>
  615. </command:commandLine>
  616. </command:commandLines>
  617. </command:example>
  618. <command:example>
  619. <maml:title>
  620. -------------- EXAMPLE 3 -------------- </maml:title>
  621. <maml:introduction>
  622. <maml:para>C:\PS&gt;</maml:para>
  623. C:\PS&gt; </maml:introduction>
  624. <dev:code>$session = New-FIMSession -Server &quot;fimserver.domain.local&quot;
  625. $group = $session | Get-FIMResource -Filter &quot;/Group[DisplayName='The Group']&quot; -Attributes &quot;All&quot;
  626. $newGroup = $group | New-FIMResource -Attributes @{&quot;DisplayName&quot;=&quot;Similar Group&quot;} -PassThru
  627. $newGroup = $newGroup | Get-FIMResource -Attributes &quot;All&quot;</dev:code>
  628. <dev:remarks>
  629. <maml:para>These commands create a new group that is similar to an other but with some attribute values changed. Note: to copy all attributes of the first group that group must be retrieved with value &quot;All&quot; in the -Attributes parameter of Get-FIMResource cmdlet. The FIMResource object returned by New-FIMResource cmdlet with -PassThru parameter does not guaranteed to exactly match newly created object, so the last command brings this $newGroup up to date.</maml:para>
  630. <maml:para></maml:para>
  631. <maml:para></maml:para>
  632. <maml:para>
  633. </maml:para>
  634. <maml:para></maml:para>
  635. </dev:remarks>
  636. <command:commandLines>
  637. <command:commandLine>
  638. <command:commandText>
  639. </command:commandText>
  640. </command:commandLine>
  641. </command:commandLines>
  642. </command:example>
  643. </command:examples>
  644. <maml:relatedLinks>
  645. </maml:relatedLinks>
  646. </command:command>
  647. <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
  648. <!--Generated by Help Cmdlet Editor-->
  649. <command:details>
  650. <command:name>New-FIMSession</command:name>
  651. <maml:description>
  652. <maml:para>The New-FIMSession cmdlet returns an FIMSession object that can be used by FIM cmdlets to establish a session with a specified FIM web service, under the specified Credentials.</maml:para>
  653. </maml:description>
  654. <maml:copyright>
  655. <maml:para />
  656. <!--Add copy right info here.-->
  657. </maml:copyright>
  658. <command:verb>New</command:verb>
  659. <command:noun>FIMSession</command:noun>
  660. <!--Add Dev version info here.-->
  661. <dev:version />
  662. </command:details>
  663. <maml:description>
  664. <!--This is the Description section-->
  665. <maml:para>The New-FIMSession cmdlet returns an FIMSession object that can be used by FIM cmdlets to establish a session with a specified remote FIM web service, with the specified Credentials.
  666. By default, the FIM PowerShell cmdlets operate in the context of the user the shell is operating in the context of, and they connect to the FIM web service the PowerShell client is configured to connect to (specified in the clients config file).
  667. - The cmdlets can be executed in the context of a different user by running the FIM PowerShell application as another user using RunAs.
  668. If a session is to be established with a different server or under the context of a different user, a new FIMSession object is created and passed as a parameter to the cmdlets that are to be executed.</maml:para>
  669. </maml:description>
  670. <command:syntax> <command:syntaxItem>
  671. <maml:name>New-FIMSession</maml:name>
  672. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue)" position = "named" >
  673. <maml:name>Credential</maml:name>
  674. <maml:description>
  675. <maml:para>This parameter is used to specify the credentials of the security context under which the session is to be created.</maml:para>
  676. </maml:description>
  677. <command:parameterValue required="true" variableLength = "false" >PSCredential</command:parameterValue>
  678. </command:parameter>
  679. <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  680. <maml:name>Server</maml:name>
  681. <maml:description>
  682. <maml:para>This parameter specifies the specific instance of the FIM web service to connect to. This can be host name:port, or IP address:port.</maml:para>
  683. </maml:description>
  684. <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue>
  685. </command:parameter>
  686. </command:syntaxItem>
  687. </command:syntax>
  688. <command:parameters>
  689. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named">
  690. <maml:name>Credential</maml:name>
  691. <maml:description>
  692. <maml:para>This parameter is used to specify the credentials of the security context under which the session is to be created.</maml:para>
  693. </maml:description>
  694. <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue>
  695. <dev:type>
  696. <maml:name>PSCredential</maml:name>
  697. <maml:uri/>
  698. </dev:type>
  699. <dev:defaultValue></dev:defaultValue>
  700. </command:parameter>
  701. <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
  702. <maml:name>Server</maml:name>
  703. <maml:description>
  704. <maml:para>This parameter specifies the specific instance of the FIM web service to connect to. This can be host name:port, or IP address:port.</maml:para>
  705. </maml:description>
  706. <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
  707. <dev:type>
  708. <maml:name>String</maml:name>
  709. <maml:uri/>
  710. </dev:type>
  711. <dev:defaultValue></dev:defaultValue>
  712. </command:parameter>
  713. </command:parameters>
  714. <command:inputTypes>
  715. <command:inputType>
  716. <dev:type>
  717. <maml:name></maml:name>
  718. <maml:uri/>
  719. <maml:description>
  720. <maml:para></maml:para>
  721. </maml:description>
  722. </dev:type>
  723. <maml:description></maml:description>
  724. </command:inputType>
  725. </command:inputTypes>
  726. <command:returnValues>
  727. <command:returnValue>
  728. <dev:type>
  729. <maml:name></maml:name>
  730. <maml:uri />
  731. <maml:description>
  732. <maml:para></maml:para>
  733. </maml:description>
  734. </dev:type>
  735. <maml:description></maml:description>
  736. </command:returnValue>
  737. </command:returnValues>
  738. <command:terminatingErrors>
  739. </command:terminatingErrors>
  740. <command:nonTerminatingErrors>
  741. </command:nonTerminatingErrors>
  742. <maml:alertSet>
  743. <maml:title></maml:title>
  744. <maml:alert>
  745. <maml:para></maml:para>
  746. </maml:alert>
  747. </maml:alertSet>
  748. <command:examples>
  749. <command:example>
  750. <maml:title>
  751. -------------- EXAMPLE 1 -------------- </maml:title>
  752. <maml:introduction>
  753. <maml:para>C:\PS&gt;</maml:para>
  754. C:\PS&gt; </maml:introduction>
  755. <dev:code>$session = New-FIMSession -Server &quot;fimserver.domain.local&quot;</dev:code>
  756. <dev:remarks>
  757. <maml:para>This command creates a session with the current user credential.</maml:para>
  758. <maml:para></maml:para>
  759. <maml:para></maml:para>
  760. <maml:para>
  761. </maml:para>
  762. <maml:para></maml:para>
  763. </dev:remarks>
  764. <command:commandLines>
  765. <command:commandLine>
  766. <command:commandText>
  767. </command:commandText>
  768. </command:commandLine>
  769. </command:commandLines>
  770. </command:example>
  771. <command:example>
  772. <maml:title>
  773. -------------- EXAMPLE 2 -------------- </maml:title>
  774. <maml:introduction>
  775. <maml:para>C:\PS&gt;</maml:para>
  776. C:\PS&gt; </maml:introduction>
  777. <dev:code>$credential = Get-Credential 'DOMAIN\ServiceAccount'
  778. $session = New-FIMSession -Server &quot;fimserver&quot; -Credential $credential</dev:code>
  779. <dev:remarks>
  780. <maml:para>These commands create session with specific credential.</maml:para>
  781. <maml:para></maml:para>
  782. <maml:para></maml:para>
  783. <maml:para>
  784. </maml:para>
  785. <maml:para></maml:para>
  786. </dev:remarks>
  787. <command:commandLines>
  788. <command:commandLine>
  789. <command:commandText>
  790. </command:commandText>
  791. </command:commandLine>
  792. </command:commandLines>
  793. </command:example>
  794. <command:example>
  795. <maml:title>
  796. -------------- EXAMPLE 3 -------------- </maml:title>
  797. <maml:introduction>
  798. <maml:para>C:\PS&gt;</maml:para>
  799. C:\PS&gt; </maml:introduction>
  800. <dev:code>$secureString = ConvertTo-SecureString &quot;P@ssW0rD!&quot; -AsPlainText -Force
  801. $credential = New-Object System.Management.Automation.PSCredential('DOMAIN\account', $secureString)
  802. $session = New-FIMSession -Server &quot;fimserver&quot; -Credential $credential</dev:code>
  803. <dev:remarks>
  804. <maml:para>These commands create session with specific credential without prompting for a password.</maml:para>
  805. <maml:para></maml:para>
  806. <maml:para></maml:para>
  807. <maml:para>
  808. </maml:para>
  809. <maml:para></maml:para>
  810. </dev:remarks>
  811. <command:commandLines>
  812. <command:commandLine>
  813. <command:commandText>
  814. </command:commandText>
  815. </command:commandLine>
  816. </command:commandLines>
  817. </command:example>
  818. </command:examples>
  819. <maml:relatedLinks>
  820. </maml:relatedLinks>
  821. </command:command>
  822. <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
  823. <!--Generated by Help Cmdlet Editor-->
  824. <command:details>
  825. <command:name>Remove-FIMResource</command:name>
  826. <maml:description>
  827. <maml:para>The Remove-FIMResource cmdlet deletes an existing object in the FIM web service Database.</maml:para>
  828. </maml:description>
  829. <maml:copyright>
  830. <maml:para />
  831. <!--Add copy right info here.-->
  832. </maml:copyright>
  833. <command:verb>Remove</command:verb>
  834. <command:noun>FIMResource</command:noun>
  835. <!--Add Dev version info here.-->
  836. <dev:version />
  837. </command:details>
  838. <maml:description>
  839. <!--This is the Description section-->
  840. <maml:para>This cmdlet is used to delete a resource from FIM. The resource specified, by ObjectID, is deleted from the FIM web service Database.</maml:para>
  841. </maml:description>
  842. <command:syntax> <command:syntaxItem>
  843. <maml:name>Remove-FIMResource</maml:name>
  844. <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "1" >
  845. <maml:name>ObjectID</maml:name>
  846. <maml:description>
  847. <maml:para>The ObjectID parameter is used to specify the FIMResource to delete.</maml:para>
  848. </maml:description>
  849. <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue>
  850. </command:parameter>
  851. <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" >
  852. <maml:name>Session</maml:name>
  853. <maml:description>
  854. <maml:para>Specifies FIMSession object to be used to establish a session with a specific FIM web service, under specific credentials.</maml:para>
  855. </maml:description>
  856. <command:parameterValue required="true" variableLength = "false" >FIMSession</command:parameterValue>
  857. </command:parameter>
  858. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  859. <maml:name>WhatIf</maml:name>
  860. <maml:description>
  861. <maml:para>Describes what would happen if you executed the command, without actually executing the command.</maml:para>
  862. </maml:description>
  863. </command:parameter>
  864. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  865. <maml:name>Confirm</maml:name>
  866. <maml:description>
  867. <maml:para>Prompts you for confirmation before executing the command.</maml:para>
  868. </maml:description>
  869. </command:parameter>
  870. </command:syntaxItem>
  871. </command:syntax>
  872. <command:parameters>
  873. <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1">
  874. <maml:name>ObjectID</maml:name>
  875. <maml:description>
  876. <maml:para>The ObjectID parameter is used to specify the FIMResource to delete.</maml:para>
  877. </maml:description>
  878. <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
  879. <dev:type>
  880. <maml:name>String</maml:name>
  881. <maml:uri/>
  882. </dev:type>
  883. <dev:defaultValue></dev:defaultValue>
  884. </command:parameter>
  885. <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named">
  886. <maml:name>Session</maml:name>
  887. <maml:description>
  888. <maml:para>Specifies FIMSession object to be used to establish a session with a specific FIM web service, under specific credentials.</maml:para>
  889. </maml:description>
  890. <command:parameterValue required="true" variableLength="false">FIMSession</command:parameterValue>
  891. <dev:type>
  892. <maml:name>FIMSession</maml:name>
  893. <maml:uri/>
  894. </dev:type>
  895. <dev:defaultValue></dev:defaultValue>
  896. </command:parameter>
  897. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  898. <maml:name>WhatIf</maml:name>
  899. <maml:description>
  900. <maml:para>Describes what would happen if you executed the command, without actually executing the command.</maml:para>
  901. </maml:description>
  902. <dev:type>
  903. <maml:name>SwitchParameter</maml:name>
  904. <maml:uri/>
  905. </dev:type>
  906. <dev:defaultValue></dev:defaultValue>
  907. </command:parameter>
  908. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  909. <maml:name>Confirm</maml:name>
  910. <maml:description>
  911. <maml:para>Prompts you for confirmation before executing the command.</maml:para>
  912. </maml:description>
  913. <dev:type>
  914. <maml:name>SwitchParameter</maml:name>
  915. <maml:uri/>
  916. </dev:type>
  917. <dev:defaultValue></dev:defaultValue>
  918. </command:parameter>
  919. </command:parameters>
  920. <command:inputTypes>
  921. <command:inputType>
  922. <dev:type>
  923. <maml:name></maml:name>
  924. <maml:uri/>
  925. <maml:description>
  926. <maml:para></maml:para>
  927. </maml:description>
  928. </dev:type>
  929. <maml:description></maml:description>
  930. </command:inputType>
  931. </command:inputTypes>
  932. <command:returnValues>
  933. <command:returnValue>
  934. <dev:type>
  935. <maml:name></maml:name>
  936. <maml:uri />
  937. <maml:description>
  938. <maml:para></maml:para>
  939. </maml:description>
  940. </dev:type>
  941. <maml:description></maml:description>
  942. </command:returnValue>
  943. </command:returnValues>
  944. <command:terminatingErrors>
  945. </command:terminatingErrors>
  946. <command:nonTerminatingErrors>
  947. </command:nonTerminatingErrors>
  948. <maml:alertSet>
  949. <maml:title></maml:title>
  950. <maml:alert>
  951. <maml:para></maml:para>
  952. </maml:alert>
  953. </maml:alertSet>
  954. <command:examples>
  955. <command:example>
  956. <maml:title>
  957. -------------- EXAMPLE 1 -------------- </maml:title>
  958. <maml:introduction>
  959. <maml:para>C:\PS&gt;</maml:para>
  960. C:\PS&gt; </maml:introduction>
  961. <dev:code>$session = New-FIMSession -Server &quot;fimserver.domain.local&quot;
  962. $group = Get-FIMResource -Filter &quot;/Group[DisplayName='Fired']&quot; -Session $session -Attributes &quot;ComputedMember&quot;
  963. $group[&quot;ComputedMember&quot;] | Remove-FIMResource -Session $session</dev:code>
  964. <dev:remarks>
  965. <maml:para>These commands delete all users from the specified group.</maml:para>
  966. <maml:para></maml:para>
  967. <maml:para></maml:para>
  968. <maml:para>
  969. </maml:para>
  970. <maml:para></maml:para>
  971. </dev:remarks>
  972. <command:commandLines>
  973. <command:commandLine>
  974. <command:commandText>
  975. </command:commandText>
  976. </command:commandLine>
  977. </command:commandLines>
  978. </command:example>
  979. <command:example>
  980. <maml:title>
  981. -------------- EXAMPLE 2 -------------- </maml:title>
  982. <maml:introduction>
  983. <maml:para>C:\PS&gt;</maml:para>
  984. C:\PS&gt; </maml:introduction>
  985. <dev:code>$s = New-FIMSession -Server &quot;fimserver.domain.local&quot;
  986. $s | Get-FIMResource -F &quot;/Person[DisplayName='John Silver']&quot; | Remove-FIMResource</dev:code>
  987. <dev:remarks>
  988. <maml:para>These commands delete specified user.</maml:para>
  989. <maml:para></maml:para>
  990. <maml:para></maml:para>
  991. <maml:para>
  992. </maml:para>
  993. <maml:para></maml:para>
  994. </dev:remarks>
  995. <command:commandLines>
  996. <command:commandLine>
  997. <command:commandText>
  998. </command:commandText>
  999. </command:commandLine>
  1000. </command:commandLines>
  1001. </command:example>
  1002. </command:examples>
  1003. <maml:relatedLinks>
  1004. </maml:relatedLinks>
  1005. </command:command>
  1006. <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
  1007. <!--Generated by Help Cmdlet Editor-->
  1008. <command:details>
  1009. <command:name>Set-FIMResource</command:name>
  1010. <maml:description>
  1011. <maml:para>The Set-FIMResource cmdlet updates an existing object in the FIM web service Database.</maml:para>
  1012. </maml:description>
  1013. <maml:copyright>
  1014. <maml:para />
  1015. <!--Add copy right info here.-->
  1016. </maml:copyright>
  1017. <command:verb>Set</command:verb>
  1018. <command:noun>FIMResource</command:noun>
  1019. <!--Add Dev version info here.-->
  1020. <dev:version />
  1021. </command:details>
  1022. <maml:description>
  1023. <!--This is the Description section-->
  1024. <maml:para>This cmdlet sets the value of specified attributes on any Resource in the FIM web service Database.</maml:para>
  1025. </maml:description>
  1026. <command:syntax> <command:syntaxItem>
  1027. <maml:name>Set-FIMResource</maml:name>
  1028. <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue)" position = "named" >
  1029. <maml:name>Instance</maml:name>
  1030. <maml:description>
  1031. <maml:para>This parameter is used to specify the FIMResource instance containing the list of updated attributes of the object to be set.</maml:para>
  1032. </maml:description>
  1033. <command:parameterValue required="true" variableLength = "false" >FIMResource</command:parameterValue>
  1034. </command:parameter>
  1035. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  1036. <maml:name>PassThru</maml:name>
  1037. <maml:description>
  1038. <maml:para>Passes through the pipeline the object being modified as it may looks like after the modification. The object is not retrieved from the FIM web service, so it can differ from the actual object. By default, this cmdlet does not pass any objects through the pipeline.</maml:para>
  1039. </maml:description>
  1040. </command:parameter>
  1041. <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" >
  1042. <maml:name>Session</maml:name>
  1043. <maml:description>
  1044. <maml:para>Specifies FIMSession object to be used to establish a session with a specific FIM web service, under specific credentials.</maml:para>
  1045. </maml:description>
  1046. <command:parameterValue required="true" variableLength = "false" >FIMSession</command:parameterValue>
  1047. </command:parameter>
  1048. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  1049. <maml:name>Locale</maml:name>
  1050. <maml:description>
  1051. <maml:para>Specifies the locale for which will be applied all modifications to an object made by this cmdlet. If the parameter is not specified then modifications will be applied for culture invariant locale.
  1052. The Locale is specified by the Culture Name associated with the locale.
  1053. E.g. Locale en-GB specifies that the English UK representation.</maml:para>
  1054. </maml:description>
  1055. <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue>
  1056. </command:parameter>
  1057. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  1058. <maml:name>WhatIf</maml:name>
  1059. <maml:description>
  1060. <maml:para>Describes what would happen if you executed the command, without actually executing the command.</maml:para>
  1061. </maml:description>
  1062. </command:parameter>
  1063. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  1064. <maml:name>Confirm</maml:name>
  1065. <maml:description>
  1066. <maml:para>Prompts you for confirmation before executing the command.</maml:para>
  1067. </maml:description>
  1068. </command:parameter>
  1069. </command:syntaxItem>
  1070. <command:syntaxItem>
  1071. <maml:name>Set-FIMResource</maml:name>
  1072. <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "1" >
  1073. <maml:name>ObjectID</maml:name>
  1074. <maml:description>
  1075. <maml:para>The ObjectID parameter is used to specify the FIMResource to update.</maml:para>
  1076. </maml:description>
  1077. <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue>
  1078. </command:parameter>
  1079. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  1080. <maml:name>Add</maml:name>
  1081. <maml:description>
  1082. <maml:para>This parameter is used to add value(s) to attributes of the resource.</maml:para>
  1083. </maml:description>
  1084. <command:parameterValue required="true" variableLength = "false" >Hashtable</command:parameterValue>
  1085. </command:parameter>
  1086. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  1087. <maml:name>Replace</maml:name>
  1088. <maml:description>
  1089. <maml:para>This parameter is used to replace value(s) of attributes of the resource.</maml:para>
  1090. </maml:description>
  1091. <command:parameterValue required="true" variableLength = "false" >Hashtable</command:parameterValue>
  1092. </command:parameter>
  1093. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  1094. <maml:name>Remove</maml:name>
  1095. <maml:description>
  1096. <maml:para>This parameter is used to remove value(s) of attributes from the resource.</maml:para>
  1097. </maml:description>
  1098. <command:parameterValue required="true" variableLength = "false" >Hashtable</command:parameterValue>
  1099. </command:parameter>
  1100. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  1101. <maml:name>PassThru</maml:name>
  1102. <maml:description>
  1103. <maml:para>Passes through the pipeline the object being modified as it may looks like after the modification. The object is not retrieved from the FIM web service, so it can differ from the actual object. By default, this cmdlet does not pass any objects through the pipeline.</maml:para>
  1104. </maml:description>
  1105. </command:parameter>
  1106. <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" >
  1107. <maml:name>Session</maml:name>
  1108. <maml:description>
  1109. <maml:para>Specifies FIMSession object to be used to establish a session with a specific FIM web service, under specific credentials.</maml:para>
  1110. </maml:description>
  1111. <command:parameterValue required="true" variableLength = "false" >FIMSession</command:parameterValue>
  1112. </command:parameter>
  1113. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  1114. <maml:name>Locale</maml:name>
  1115. <maml:description>
  1116. <maml:para>Specifies the locale for which will be applied all modifications to an object made by this cmdlet. If the parameter is not specified then modifications will be applied for culture invariant locale.
  1117. The Locale is specified by the Culture Name associated with the locale.
  1118. E.g. Locale en-GB specifies that the English UK representation.</maml:para>
  1119. </maml:description>
  1120. <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue>
  1121. </command:parameter>
  1122. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  1123. <maml:name>WhatIf</maml:name>
  1124. <maml:description>
  1125. <maml:para>Describes what would happen if you executed the command, without actually executing the command.</maml:para>
  1126. </maml:description>
  1127. </command:parameter>
  1128. <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
  1129. <maml:name>Confirm</maml:name>
  1130. <maml:description>
  1131. <maml:para>Prompts you for confirmation before executing the command.</maml:para>
  1132. </maml:description>
  1133. </command:parameter>
  1134. </command:syntaxItem>
  1135. </command:syntax>
  1136. <command:parameters>
  1137. <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named">
  1138. <maml:name>Instance</maml:name>
  1139. <maml:description>
  1140. <maml:para>This parameter is used to specify the FIMResource instance containing the list of updated attributes of the object to be set.</maml:para>
  1141. </maml:description>
  1142. <command:parameterValue required="true" variableLength="false">FIMResource</command:parameterValue>
  1143. <dev:type>
  1144. <maml:name>FIMResource</maml:name>
  1145. <maml:uri/>
  1146. </dev:type>
  1147. <dev:defaultValue></dev:defaultValue>
  1148. </command:parameter>
  1149. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  1150. <maml:name>PassThru</maml:name>
  1151. <maml:description>
  1152. <maml:para>Passes through the pipeline the object being modified as it may looks like after the modification. The object is not retrieved from the FIM web service, so it can differ from the actual object. By default, this cmdlet does not pass any objects through the pipeline.</maml:para>
  1153. </maml:description>
  1154. <dev:type>
  1155. <maml:name>SwitchParameter</maml:name>
  1156. <maml:uri/>
  1157. </dev:type>
  1158. <dev:defaultValue></dev:defaultValue>
  1159. </command:parameter>
  1160. <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named">
  1161. <maml:name>Session</maml:name>
  1162. <maml:description>
  1163. <maml:para>Specifies FIMSession object to be used to establish a session with a specific FIM web service, under specific credentials.</maml:para>
  1164. </maml:description>
  1165. <command:parameterValue required="true" variableLength="false">FIMSession</command:parameterValue>
  1166. <dev:type>
  1167. <maml:name>FIMSession</maml:name>
  1168. <maml:uri/>
  1169. </dev:type>
  1170. <dev:defaultValue></dev:defaultValue>
  1171. </command:parameter>
  1172. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  1173. <maml:name>Locale</maml:name>
  1174. <maml:description>
  1175. <maml:para>Specifies the locale for which will be applied all modifications to an object made by this cmdlet. If the parameter is not specified then modifications will be applied for culture invariant locale.
  1176. The Locale is specified by the Culture Name associated with the locale.
  1177. E.g. Locale en-GB specifies that the English UK representation.</maml:para>
  1178. </maml:description>
  1179. <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
  1180. <dev:type>
  1181. <maml:name>String</maml:name>
  1182. <maml:uri/>
  1183. </dev:type>
  1184. <dev:defaultValue></dev:defaultValue>
  1185. </command:parameter>
  1186. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  1187. <maml:name>WhatIf</maml:name>
  1188. <maml:description>
  1189. <maml:para>Describes what would happen if you executed the command, without actually executing the command.</maml:para>
  1190. </maml:description>
  1191. <dev:type>
  1192. <maml:name>SwitchParameter</maml:name>
  1193. <maml:uri/>
  1194. </dev:type>
  1195. <dev:defaultValue></dev:defaultValue>
  1196. </command:parameter>
  1197. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  1198. <maml:name>Confirm</maml:name>
  1199. <maml:description>
  1200. <maml:para>Prompts you for confirmation before executing the command.</maml:para>
  1201. </maml:description>
  1202. <dev:type>
  1203. <maml:name>SwitchParameter</maml:name>
  1204. <maml:uri/>
  1205. </dev:type>
  1206. <dev:defaultValue></dev:defaultValue>
  1207. </command:parameter>
  1208. <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1">
  1209. <maml:name>ObjectID</maml:name>
  1210. <maml:description>
  1211. <maml:para>The ObjectID parameter is used to specify the FIMResource to update.</maml:para>
  1212. </maml:description>
  1213. <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
  1214. <dev:type>
  1215. <maml:name>String</maml:name>
  1216. <maml:uri/>
  1217. </dev:type>
  1218. <dev:defaultValue></dev:defaultValue>
  1219. </command:parameter>
  1220. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  1221. <maml:name>Add</maml:name>
  1222. <maml:description>
  1223. <maml:para>This parameter is used to add value(s) to attributes of the resource.</maml:para>
  1224. </maml:description>
  1225. <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue>
  1226. <dev:type>
  1227. <maml:name>Hashtable</maml:name>
  1228. <maml:uri/>
  1229. </dev:type>
  1230. <dev:defaultValue></dev:defaultValue>
  1231. </command:parameter>
  1232. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  1233. <maml:name>Replace</maml:name>
  1234. <maml:description>
  1235. <maml:para>This parameter is used to replace value(s) of attributes of the resource.</maml:para>
  1236. </maml:description>
  1237. <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue>
  1238. <dev:type>
  1239. <maml:name>Hashtable</maml:name>
  1240. <maml:uri/>
  1241. </dev:type>
  1242. <dev:defaultValue></dev:defaultValue>
  1243. </command:parameter>
  1244. <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
  1245. <maml:name>Remove</maml:name>
  1246. <maml:description>
  1247. <maml:para>This parameter is used to remove value(s) of attributes from the resource.</maml:para>
  1248. </maml:description>
  1249. <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue>
  1250. <dev:type>
  1251. <maml:name>Hashtable</maml:name>
  1252. <maml:uri/>
  1253. </dev:type>
  1254. <dev:defaultValue></dev:defaultValue>
  1255. </command:parameter>
  1256. </command:parameters>
  1257. <command:inputTypes>
  1258. <command:inputType>
  1259. <dev:type>
  1260. <maml:name></maml:name>
  1261. <maml:uri/>
  1262. <maml:description>
  1263. <maml:para></maml:para>
  1264. </maml:description>
  1265. </dev:type>
  1266. <maml:description></maml:description>
  1267. </command:inputType>
  1268. </command:inputTypes>
  1269. <command:returnValues>
  1270. <command:returnValue>
  1271. <dev:type>
  1272. <maml:name></maml:name>
  1273. <maml:uri />
  1274. <maml:description>
  1275. <maml:para></maml:para>
  1276. </maml:description>
  1277. </dev:type>
  1278. <maml:description></maml:description>
  1279. </command:returnValue>
  1280. </command:returnValues>
  1281. <command:terminatingErrors>
  1282. </command:terminatingErrors>
  1283. <command:nonTerminatingErrors>
  1284. </command:nonTerminatingErrors>
  1285. <maml:alertSet>
  1286. <maml:title></maml:title>
  1287. <maml:alert>
  1288. <maml:para></maml:para>
  1289. </maml:alert>
  1290. </maml:alertSet>
  1291. <command:examples>
  1292. <command:example>
  1293. <maml:title>
  1294. -------------- EXAMPLE 1 -------------- </maml:title>
  1295. <maml:introduction>
  1296. <maml:para>C:\PS&gt;</maml:para>
  1297. C:\PS&gt; </maml:introduction>
  1298. <dev:code>$session = New-FIMSession -Server &quot;fimserver.domain.local&quot;
  1299. $user = Get-FIMResource -Filter &quot;/person[DisplayName='Johann Sebastian Bach']&quot; -Session $session
  1300. $user.SetValue(&quot;City&quot;, &quot;Leipzig&quot;)
  1301. $user.SetValue(&quot;Country&quot;, &quot;Germany&quot;)
  1302. Set-FIMResource -Instance $user -Session $session -Locale &quot;en-US&quot;</dev:code>
  1303. <dev:remarks>
  1304. <maml:para>These commands set new values in a specific locale for some attributes of a specific user.</maml:para>
  1305. <maml:para></maml:para>
  1306. <maml:para></maml:para>
  1307. <maml:para>
  1308. </maml:para>
  1309. <maml:para></maml:para>
  1310. </dev:remarks>
  1311. <command:commandLines>
  1312. <command:commandLine>
  1313. <command:commandText>
  1314. </command:commandText>
  1315. </command:commandLine>
  1316. </command:commandLines>
  1317. </command:example>
  1318. <command:example>
  1319. <maml:title>
  1320. -------------- EXAMPLE 2 -------------- </maml:title>
  1321. <maml:introduction>
  1322. <maml:para>C:\PS&gt;</maml:para>
  1323. C:\PS&gt; </maml:introduction>
  1324. <dev:code>$s = New-FIMSession -Server &quot;fimserver.domain.local&quot;
  1325. $s | Get-FIMResource -Filter &quot;/person[City='St. Petersburg']&quot; | Set-FIMResource -Replace @{&quot;City&quot;=&quot;Saint Petersburg&quot;}</dev:code>
  1326. <dev:remarks>
  1327. <maml:para>These commands replace City value 'St. Petersburg' with 'Saint Petersburg' for all users.</maml:para>
  1328. <maml:para></maml:para>
  1329. <maml:para></maml:para>
  1330. <maml:para>
  1331. </maml:para>
  1332. <maml:para></maml:para>
  1333. </dev:remarks>
  1334. <command:commandLines>
  1335. <command:commandLine>
  1336. <command:commandText>
  1337. </command:commandText>
  1338. </command:commandLine>
  1339. </command:commandLines>
  1340. </command:example>
  1341. <command:example>
  1342. <maml:title>
  1343. -------------- EXAMPLE 3 -------------- </maml:title>
  1344. <maml:introduction>
  1345. <maml:para>C:\PS&gt;</maml:para>
  1346. C:\PS&gt; </maml:introduction>
  1347. <dev:code>$session = New-FIMSession -Server &quot;fimserver.domain.local&quot;
  1348. $group = Get-FIMResource -Filter &quot;/Group[DisplayName='Office cleaners']&quot; -Session $session -Attributes &quot;ComputedMember&quot;
  1349. $group[&quot;ComputedMember&quot;] | Set-FIMResource -Session $session -Replace @{&quot;OfficeFax&quot;=$null}</dev:code>
  1350. <dev:remarks>
  1351. <maml:para>These commands remove attribute OfficeFax from all office cleaners.</maml:para>
  1352. <maml:para></maml:para>
  1353. <maml:para></maml:para>
  1354. <maml:para>
  1355. </maml:para>
  1356. <maml:para></maml:para>
  1357. </dev:remarks>
  1358. <command:commandLines>
  1359. <command:commandLine>
  1360. <command:commandText>
  1361. </command:commandText>
  1362. </command:commandLine>
  1363. </command:commandLines>
  1364. </command:example>
  1365. </command:examples>
  1366. <maml:relatedLinks>
  1367. </maml:relatedLinks>
  1368. </command:command>
  1369. </helpItems>