mirror of
https://github.com/benclaussen/NetboxPS.git
synced 2025-12-13 18:02:29 +00:00
Move Get-NetboxCircuit
This commit is contained in:
Ben Claussen
parent
de9b616093
commit
6636fe74d8
2 changed files with 131 additions and 83 deletions
131
Functions/Circuits/Circuits/Get-NetboxCircuit.ps1
Normal file
131
Functions/Circuits/Circuits/Get-NetboxCircuit.ps1
Normal file
|
|
@ -0,0 +1,131 @@
|
||||||
|
<#
|
||||||
|
.NOTES
|
||||||
|
===========================================================================
|
||||||
|
Created with: SAPIEN Technologies, Inc., PowerShell Studio 2020 v5.7.172
|
||||||
|
Created on: 3/23/2020 12:15
|
||||||
|
Created by: Claussen
|
||||||
|
Organization: NEOnet
|
||||||
|
Filename: Get-NetboxCircuit.ps1
|
||||||
|
===========================================================================
|
||||||
|
.DESCRIPTION
|
||||||
|
A description of the file.
|
||||||
|
#>
|
||||||
|
|
||||||
|
|
||||||
|
function Get-NetboxCircuit {
|
||||||
|
<#
|
||||||
|
.SYNOPSIS
|
||||||
|
Gets one or more circuits
|
||||||
|
|
||||||
|
.DESCRIPTION
|
||||||
|
A detailed description of the Get-NetboxCircuit function.
|
||||||
|
|
||||||
|
.PARAMETER Id
|
||||||
|
Database ID of circuit. This will query for exactly the IDs provided
|
||||||
|
|
||||||
|
.PARAMETER CID
|
||||||
|
Circuit ID
|
||||||
|
|
||||||
|
.PARAMETER InstallDate
|
||||||
|
Date of installation
|
||||||
|
|
||||||
|
.PARAMETER CommitRate
|
||||||
|
Committed rate in Kbps
|
||||||
|
|
||||||
|
.PARAMETER Query
|
||||||
|
A raw search query... As if you were searching the web site
|
||||||
|
|
||||||
|
.PARAMETER Provider
|
||||||
|
The name or ID of the provider. Provide either [string] or [int]. String will search provider names, integer will search database IDs
|
||||||
|
|
||||||
|
.PARAMETER Type
|
||||||
|
Type of circuit. Provide either [string] or [int]. String will search provider type names, integer will search database IDs
|
||||||
|
|
||||||
|
.PARAMETER Site
|
||||||
|
Location/site of circuit. Provide either [string] or [int]. String will search site names, integer will search database IDs
|
||||||
|
|
||||||
|
.PARAMETER Tenant
|
||||||
|
Tenant assigned to circuit. Provide either [string] or [int]. String will search tenant names, integer will search database IDs
|
||||||
|
|
||||||
|
.PARAMETER Limit
|
||||||
|
A description of the Limit parameter.
|
||||||
|
|
||||||
|
.PARAMETER Offset
|
||||||
|
A description of the Offset parameter.
|
||||||
|
|
||||||
|
.PARAMETER Raw
|
||||||
|
A description of the Raw parameter.
|
||||||
|
|
||||||
|
.PARAMETER ID__IN
|
||||||
|
Multiple unique DB IDs to retrieve
|
||||||
|
|
||||||
|
.EXAMPLE
|
||||||
|
PS C:\> Get-NetboxCircuit
|
||||||
|
|
||||||
|
.NOTES
|
||||||
|
Additional information about the function.
|
||||||
|
#>
|
||||||
|
|
||||||
|
[CmdletBinding(DefaultParameterSetName = 'Query')]
|
||||||
|
param
|
||||||
|
(
|
||||||
|
[Parameter(ParameterSetName = 'ById')]
|
||||||
|
[uint16[]]$Id,
|
||||||
|
|
||||||
|
[Parameter(ParameterSetName = 'Query')]
|
||||||
|
[string]$CID,
|
||||||
|
|
||||||
|
[Parameter(ParameterSetName = 'Query')]
|
||||||
|
[datetime]$InstallDate,
|
||||||
|
|
||||||
|
[Parameter(ParameterSetName = 'Query')]
|
||||||
|
[uint32]$CommitRate,
|
||||||
|
|
||||||
|
[Parameter(ParameterSetName = 'Query')]
|
||||||
|
[string]$Query,
|
||||||
|
|
||||||
|
[Parameter(ParameterSetName = 'Query')]
|
||||||
|
[object]$Provider,
|
||||||
|
|
||||||
|
[Parameter(ParameterSetName = 'Query')]
|
||||||
|
[object]$Type,
|
||||||
|
|
||||||
|
[Parameter(ParameterSetName = 'Query')]
|
||||||
|
[string]$Site,
|
||||||
|
|
||||||
|
[Parameter(ParameterSetName = 'Query')]
|
||||||
|
[string]$Tenant,
|
||||||
|
|
||||||
|
[Parameter(ParameterSetName = 'Query')]
|
||||||
|
[uint16]$Limit,
|
||||||
|
|
||||||
|
[Parameter(ParameterSetName = 'Query')]
|
||||||
|
[uint16]$Offset,
|
||||||
|
|
||||||
|
[switch]$Raw
|
||||||
|
)
|
||||||
|
|
||||||
|
switch ($PSCmdlet.ParameterSetName) {
|
||||||
|
'ById' {
|
||||||
|
foreach ($i in $ID) {
|
||||||
|
$Segments = [System.Collections.ArrayList]::new(@('circuits', 'circuits', $i))
|
||||||
|
|
||||||
|
$URIComponents = BuildURIComponents -URISegments $Segments.Clone() -ParametersDictionary $PSBoundParameters -SkipParameterByName "Id"
|
||||||
|
|
||||||
|
$URI = BuildNewURI -Segments $URIComponents.Segments -Parameters $URIComponents.Parameters
|
||||||
|
|
||||||
|
InvokeNetboxRequest -URI $URI -Raw:$Raw
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
default {
|
||||||
|
$Segments = [System.Collections.ArrayList]::new(@('circuits', 'circuits'))
|
||||||
|
|
||||||
|
$URIComponents = BuildURIComponents -URISegments $Segments.Clone() -ParametersDictionary $PSBoundParameters
|
||||||
|
|
||||||
|
$URI = BuildNewURI -Segments $URIComponents.Segments -Parameters $URIComponents.Parameters
|
||||||
|
|
||||||
|
InvokeNetboxRequest -URI $URI -Raw:$Raw
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -1,83 +0,0 @@
|
||||||
<#
|
|
||||||
.NOTES
|
|
||||||
===========================================================================
|
|
||||||
Created with: SAPIEN Technologies, Inc., PowerShell Studio 2020 v5.7.172
|
|
||||||
Created on: 3/23/2020 12:15
|
|
||||||
Created by: Claussen
|
|
||||||
Organization: NEOnet
|
|
||||||
Filename: Get-NetboxCircuit.ps1
|
|
||||||
===========================================================================
|
|
||||||
.DESCRIPTION
|
|
||||||
A description of the file.
|
|
||||||
#>
|
|
||||||
|
|
||||||
|
|
||||||
function Get-NetboxCircuit {
|
|
||||||
<#
|
|
||||||
.SYNOPSIS
|
|
||||||
Gets one or more circuits
|
|
||||||
|
|
||||||
.DESCRIPTION
|
|
||||||
A detailed description of the Get-NetboxCircuit function.
|
|
||||||
|
|
||||||
.PARAMETER CID
|
|
||||||
Circuit ID
|
|
||||||
|
|
||||||
.PARAMETER InstallDate
|
|
||||||
Date of installation
|
|
||||||
|
|
||||||
.PARAMETER CommitRate
|
|
||||||
Committed rate in Kbps
|
|
||||||
|
|
||||||
.PARAMETER Query
|
|
||||||
A raw search query... As if you were searching the web site
|
|
||||||
|
|
||||||
.PARAMETER Provider
|
|
||||||
The name or ID of the provider. Provide either [string] or [int]. String will search provider names, integer will search database IDs
|
|
||||||
|
|
||||||
.PARAMETER Type
|
|
||||||
Type of circuit. Provide either [string] or [int]. String will search provider type names, integer will search database IDs
|
|
||||||
|
|
||||||
.PARAMETER Site
|
|
||||||
Location/site of circuit. Provide either [string] or [int]. String will search site names, integer will search database IDs
|
|
||||||
|
|
||||||
.PARAMETER Tenant
|
|
||||||
Tenant assigned to circuit. Provide either [string] or [int]. String will search tenant names, integer will search database IDs
|
|
||||||
|
|
||||||
.PARAMETER Id
|
|
||||||
Database ID of circuit. This will query for exactly the IDs provided
|
|
||||||
|
|
||||||
.PARAMETER ID__IN
|
|
||||||
Multiple unique DB IDs to retrieve
|
|
||||||
|
|
||||||
.EXAMPLE
|
|
||||||
PS C:\> Get-NetboxCircuit
|
|
||||||
|
|
||||||
.NOTES
|
|
||||||
Additional information about the function.
|
|
||||||
#>
|
|
||||||
|
|
||||||
[CmdletBinding()]
|
|
||||||
param
|
|
||||||
(
|
|
||||||
[string]$CID,
|
|
||||||
|
|
||||||
[datetime]$InstallDate,
|
|
||||||
|
|
||||||
[uint32]$CommitRate,
|
|
||||||
|
|
||||||
[string]$Query,
|
|
||||||
|
|
||||||
[object]$Provider,
|
|
||||||
|
|
||||||
[object]$Type,
|
|
||||||
|
|
||||||
[string]$Site,
|
|
||||||
|
|
||||||
[string]$Tenant,
|
|
||||||
|
|
||||||
[uint16[]]$Id
|
|
||||||
)
|
|
||||||
|
|
||||||
#TODO: Place script here
|
|
||||||
}
|
|
||||||
Loading…
Add table
Reference in a new issue