mirror of
https://github.com/benclaussen/NetboxPS.git
synced 2025-12-13 18:02:29 +00:00
Add help block for Get-NetboxTenant
This commit is contained in:
parent
657a8405bc
commit
a98495e5f4
1 changed files with 44 additions and 0 deletions
|
|
@ -13,6 +13,50 @@
|
||||||
|
|
||||||
|
|
||||||
function Get-NetboxTenant {
|
function Get-NetboxTenant {
|
||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Get a tenent from Netbox
|
||||||
|
|
||||||
|
.DESCRIPTION
|
||||||
|
A detailed description of the Get-NetboxTenant function.
|
||||||
|
|
||||||
|
.PARAMETER Name
|
||||||
|
The specific name of the tenant. Must match exactly as is defined in Netbox
|
||||||
|
|
||||||
|
.PARAMETER Slug
|
||||||
|
The specific slug of the tenant. Must match exactly as is defined in Netbox
|
||||||
|
|
||||||
|
.PARAMETER Id
|
||||||
|
The database ID of the tenant
|
||||||
|
|
||||||
|
.PARAMETER Query
|
||||||
|
A standard search query that will match one or more tenants.
|
||||||
|
|
||||||
|
.PARAMETER Group
|
||||||
|
The specific group as defined in Netbox.
|
||||||
|
|
||||||
|
.PARAMETER GroupID
|
||||||
|
The database ID of the group in Netbox
|
||||||
|
|
||||||
|
.PARAMETER CustomFields
|
||||||
|
Hashtable in the format @{"field_name" = "value"} to search
|
||||||
|
|
||||||
|
.PARAMETER Limit
|
||||||
|
Limit the number of results to this number
|
||||||
|
|
||||||
|
.PARAMETER Offset
|
||||||
|
Start the search at this index in results
|
||||||
|
|
||||||
|
.PARAMETER Raw
|
||||||
|
Return the unparsed data from the HTTP request
|
||||||
|
|
||||||
|
.EXAMPLE
|
||||||
|
PS C:\> Get-NetboxTenant
|
||||||
|
|
||||||
|
.NOTES
|
||||||
|
Additional information about the function.
|
||||||
|
#>
|
||||||
|
|
||||||
[CmdletBinding()]
|
[CmdletBinding()]
|
||||||
param
|
param
|
||||||
(
|
(
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue