/docs/New-SnipeitLicense.md

https://github.com/snazy2000/SnipeitPS · Markdown · 363 lines · 287 code · 76 blank · 0 comment · 0 complexity · 94613ab1a712d1fb9903b92cabda1314 MD5 · raw file

  1. ---
  2. external help file: SnipeitPS-help.xml
  3. Module Name: SnipeitPS
  4. online version:
  5. schema: 2.0.0
  6. ---
  7. # New-SnipeitLicense
  8. ## SYNOPSIS
  9. Creates a licence
  10. ## SYNTAX
  11. ```
  12. New-SnipeitLicense [-name] <String> [-seats] <Int32> [[-category_id] <Int32>] [[-company_id] <Int32>]
  13. [[-expiration_date] <DateTime>] [[-license_email] <MailAddress>] [[-license_name] <String>]
  14. [[-maintained] <Boolean>] [[-manufacturer_id] <Int32>] [[-notes] <String>] [[-order_number] <String>]
  15. [[-purchase_cost] <Single>] [[-purchase_date] <DateTime>] [[-reassignable] <Boolean>] [[-serial] <String>]
  16. [[-supplier_id] <Int32>] [[-termination_date] <DateTime>] [[-url] <String>] [[-apiKey] <String>] [-WhatIf]
  17. [-Confirm] [<CommonParameters>]
  18. ```
  19. ## DESCRIPTION
  20. Creates a new licence on Snipe-It system
  21. ## EXAMPLES
  22. ### EXAMPLE 1
  23. ```
  24. New-SnipeitLicence -name "License" -seats 3 -company_id 1
  25. ```
  26. ## PARAMETERS
  27. ### -apiKey
  28. Deprecated parameter, please use Connect-SnipeitPS instead.
  29. Users API Key for Snipeit.
  30. ```yaml
  31. Type: String
  32. Parameter Sets: (All)
  33. Aliases:
  34. Required: False
  35. Position: 19
  36. Default value: None
  37. Accept pipeline input: False
  38. Accept wildcard characters: False
  39. ```
  40. ### -category_id
  41. {{ Fill category_id Description }}
  42. ```yaml
  43. Type: Int32
  44. Parameter Sets: (All)
  45. Aliases:
  46. Required: False
  47. Position: 3
  48. Default value: 0
  49. Accept pipeline input: False
  50. Accept wildcard characters: False
  51. ```
  52. ### -company_id
  53. Id number of company license belongs to
  54. ```yaml
  55. Type: Int32
  56. Parameter Sets: (All)
  57. Aliases:
  58. Required: False
  59. Position: 4
  60. Default value: 0
  61. Accept pipeline input: False
  62. Accept wildcard characters: False
  63. ```
  64. ### -expiration_date
  65. Date of license expiration
  66. ```yaml
  67. Type: DateTime
  68. Parameter Sets: (All)
  69. Aliases:
  70. Required: False
  71. Position: 5
  72. Default value: None
  73. Accept pipeline input: False
  74. Accept wildcard characters: False
  75. ```
  76. ### -license_email
  77. Email address associated with license
  78. ```yaml
  79. Type: MailAddress
  80. Parameter Sets: (All)
  81. Aliases:
  82. Required: False
  83. Position: 6
  84. Default value: None
  85. Accept pipeline input: False
  86. Accept wildcard characters: False
  87. ```
  88. ### -license_name
  89. Name of license contact person
  90. ```yaml
  91. Type: String
  92. Parameter Sets: (All)
  93. Aliases:
  94. Required: False
  95. Position: 7
  96. Default value: None
  97. Accept pipeline input: False
  98. Accept wildcard characters: False
  99. ```
  100. ### -maintained
  101. Maintained status of license
  102. ```yaml
  103. Type: Boolean
  104. Parameter Sets: (All)
  105. Aliases:
  106. Required: False
  107. Position: 8
  108. Default value: False
  109. Accept pipeline input: False
  110. Accept wildcard characters: False
  111. ```
  112. ### -manufacturer_id
  113. ID number of manufacturer of license.
  114. ```yaml
  115. Type: Int32
  116. Parameter Sets: (All)
  117. Aliases:
  118. Required: False
  119. Position: 9
  120. Default value: 0
  121. Accept pipeline input: False
  122. Accept wildcard characters: False
  123. ```
  124. ### -name
  125. Name of license being created
  126. ```yaml
  127. Type: String
  128. Parameter Sets: (All)
  129. Aliases:
  130. Required: True
  131. Position: 1
  132. Default value: None
  133. Accept pipeline input: False
  134. Accept wildcard characters: False
  135. ```
  136. ### -notes
  137. License Notes
  138. ```yaml
  139. Type: String
  140. Parameter Sets: (All)
  141. Aliases:
  142. Required: False
  143. Position: 10
  144. Default value: None
  145. Accept pipeline input: False
  146. Accept wildcard characters: False
  147. ```
  148. ### -order_number
  149. Order number of license purchase
  150. ```yaml
  151. Type: String
  152. Parameter Sets: (All)
  153. Aliases:
  154. Required: False
  155. Position: 11
  156. Default value: None
  157. Accept pipeline input: False
  158. Accept wildcard characters: False
  159. ```
  160. ### -purchase_cost
  161. Cost of license
  162. ```yaml
  163. Type: Single
  164. Parameter Sets: (All)
  165. Aliases:
  166. Required: False
  167. Position: 12
  168. Default value: 0
  169. Accept pipeline input: False
  170. Accept wildcard characters: False
  171. ```
  172. ### -purchase_date
  173. Date of license purchase
  174. ```yaml
  175. Type: DateTime
  176. Parameter Sets: (All)
  177. Aliases:
  178. Required: False
  179. Position: 13
  180. Default value: None
  181. Accept pipeline input: False
  182. Accept wildcard characters: False
  183. ```
  184. ### -reassignable
  185. Is license reassignable?
  186. ```yaml
  187. Type: Boolean
  188. Parameter Sets: (All)
  189. Aliases:
  190. Required: False
  191. Position: 14
  192. Default value: False
  193. Accept pipeline input: False
  194. Accept wildcard characters: False
  195. ```
  196. ### -seats
  197. Number of license seats owned.
  198. ```yaml
  199. Type: Int32
  200. Parameter Sets: (All)
  201. Aliases:
  202. Required: True
  203. Position: 2
  204. Default value: 0
  205. Accept pipeline input: False
  206. Accept wildcard characters: False
  207. ```
  208. ### -serial
  209. Serialnumber of license
  210. ```yaml
  211. Type: String
  212. Parameter Sets: (All)
  213. Aliases:
  214. Required: False
  215. Position: 15
  216. Default value: None
  217. Accept pipeline input: False
  218. Accept wildcard characters: False
  219. ```
  220. ### -supplier_id
  221. ID number of license supplier
  222. ```yaml
  223. Type: Int32
  224. Parameter Sets: (All)
  225. Aliases:
  226. Required: False
  227. Position: 16
  228. Default value: 0
  229. Accept pipeline input: False
  230. Accept wildcard characters: False
  231. ```
  232. ### -termination_date
  233. Termination date for license.
  234. ```yaml
  235. Type: DateTime
  236. Parameter Sets: (All)
  237. Aliases:
  238. Required: False
  239. Position: 17
  240. Default value: None
  241. Accept pipeline input: False
  242. Accept wildcard characters: False
  243. ```
  244. ### -url
  245. Deprecated parameter, please use Connect-SnipeitPS instead.
  246. URL of Snipeit system.
  247. ```yaml
  248. Type: String
  249. Parameter Sets: (All)
  250. Aliases:
  251. Required: False
  252. Position: 18
  253. Default value: None
  254. Accept pipeline input: False
  255. Accept wildcard characters: False
  256. ```
  257. ### -Confirm
  258. Prompts you for confirmation before running the cmdlet.
  259. ```yaml
  260. Type: SwitchParameter
  261. Parameter Sets: (All)
  262. Aliases: cf
  263. Required: False
  264. Position: Named
  265. Default value: None
  266. Accept pipeline input: False
  267. Accept wildcard characters: False
  268. ```
  269. ### -WhatIf
  270. Shows what would happen if the cmdlet runs.
  271. The cmdlet is not run.
  272. ```yaml
  273. Type: SwitchParameter
  274. Parameter Sets: (All)
  275. Aliases: wi
  276. Required: False
  277. Position: Named
  278. Default value: None
  279. Accept pipeline input: False
  280. Accept wildcard characters: False
  281. ```
  282. ### CommonParameters
  283. This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
  284. ## INPUTS
  285. ## OUTPUTS
  286. ## NOTES
  287. ## RELATED LINKS