NetboxPS/Functions/Tenancy/ContactAssignment/New-NetboxContactAssignment.ps1

109 lines
3 KiB
PowerShell
Raw Normal View History

2023-02-24 15:14:04 -05:00

2023-02-16 09:47:00 -05:00
function New-NetboxContactRole {
<#
.SYNOPSIS
Create a new contact role in Netbox
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.DESCRIPTION
Creates a new contact role object in Netbox
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.PARAMETER Content_Type
A description of the Content_Type parameter.
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.PARAMETER Object_Id
A description of the Object_Id parameter.
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.PARAMETER Contact
A description of the Contact parameter.
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.PARAMETER Role
A description of the Role parameter.
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.PARAMETER Priority
A description of the Priority parameter.
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.PARAMETER Raw
Return the unparsed data from the HTTP request
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.EXAMPLE
PS C:\> New-NetboxContactAssignment -Name 'Leroy Jenkins' -Email 'leroy.jenkins@example.com'
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.NOTES
Additional information about the function.
#>
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
[CmdletBinding(ConfirmImpact = 'Low',
SupportsShouldProcess = $true)]
[OutputType([pscustomobject])]
param
(
[Parameter(Mandatory = $true,
ValueFromPipelineByPropertyName = $true)]
[object]$Content_Type,
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
[Parameter(Mandatory = $true)]
v1.8.4 (#50) * Fixing Interface Type parameter (#42) * Fixing #41 * Update `deploy.ps1` to remove trailing whitespaces from psd1 * Increase version to 1.7.3 * Fix location of whitespace cleanup in `deploy.ps1` * Device port support (#44) * Fixing #41 * Correct for OTBS * Start work on Front and Rear ports * Revert "Start work on Front and Rear ports" This reverts commit 257709fe2af5af5fbe4496b2d5b68481d80bf101. * Fixing #41 * Add-NetboxDCIMRearPort function * Revert "Revert "Start work on Front and Rear ports"" This reverts commit 4f6625af2dd95a5797da0efcff40774095ad2e95. * Fix incorrect parameter variable types * Parameter type adjustments * Create function to get tag information * Added Mark_Connected parameter * Add Set-NetboxDCIMRearPort function * Added Remove-NetboxDCIMRearPort function * Added validate pattern for Color parameter * Added Add-NetboxDCIMFrontPort function * Fixed param list missing Force parameter * Added Set-NetboxDCIMFrontPort function * Added Remove-NetboxDCIMFrontPort function * Init. functions for cables and cable terminations * Reformatting using OTBS Also working on defining tags by slug as an extra parameter, which appears only in Add-NetboxDCIMRearPort currently * Remove Tags_Slug parameter In hindsight implementing would create extra work that could be hard to maintain. Can be easily achieved outside of the function. * Update psproj * Fix braces * Update Postman for Netbox v3.4.5 * Update vscode settings * Update version 1.8.0 * Update psproj * Update `uint16` to `uint64` where applicable for #49 * dev v1.8.1 * More `uint64` updates for #49 * `[uint64]` updates * Add IPAMAddressRange functions * Move limit/offset parameters to end of list * Update psproj with IPAMAddressRange files * Remove whitespaces * Update version to 1.8.3 * Add Set-NetboxIPAMAddressRange * Remove incorrect parameter * Update version to 1.8.4 --------- Co-authored-by: SheffSix <jbeck1867@gmail.com> Co-authored-by: James Beck <jim@beck81.co.uk>
2023-11-07 10:30:05 -05:00
[uint64]$Object_Id,
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
[Parameter(Mandatory = $true)]
v1.8.4 (#50) * Fixing Interface Type parameter (#42) * Fixing #41 * Update `deploy.ps1` to remove trailing whitespaces from psd1 * Increase version to 1.7.3 * Fix location of whitespace cleanup in `deploy.ps1` * Device port support (#44) * Fixing #41 * Correct for OTBS * Start work on Front and Rear ports * Revert "Start work on Front and Rear ports" This reverts commit 257709fe2af5af5fbe4496b2d5b68481d80bf101. * Fixing #41 * Add-NetboxDCIMRearPort function * Revert "Revert "Start work on Front and Rear ports"" This reverts commit 4f6625af2dd95a5797da0efcff40774095ad2e95. * Fix incorrect parameter variable types * Parameter type adjustments * Create function to get tag information * Added Mark_Connected parameter * Add Set-NetboxDCIMRearPort function * Added Remove-NetboxDCIMRearPort function * Added validate pattern for Color parameter * Added Add-NetboxDCIMFrontPort function * Fixed param list missing Force parameter * Added Set-NetboxDCIMFrontPort function * Added Remove-NetboxDCIMFrontPort function * Init. functions for cables and cable terminations * Reformatting using OTBS Also working on defining tags by slug as an extra parameter, which appears only in Add-NetboxDCIMRearPort currently * Remove Tags_Slug parameter In hindsight implementing would create extra work that could be hard to maintain. Can be easily achieved outside of the function. * Update psproj * Fix braces * Update Postman for Netbox v3.4.5 * Update vscode settings * Update version 1.8.0 * Update psproj * Update `uint16` to `uint64` where applicable for #49 * dev v1.8.1 * More `uint64` updates for #49 * `[uint64]` updates * Add IPAMAddressRange functions * Move limit/offset parameters to end of list * Update psproj with IPAMAddressRange files * Remove whitespaces * Update version to 1.8.3 * Add Set-NetboxIPAMAddressRange * Remove incorrect parameter * Update version to 1.8.4 --------- Co-authored-by: SheffSix <jbeck1867@gmail.com> Co-authored-by: James Beck <jim@beck81.co.uk>
2023-11-07 10:30:05 -05:00
[uint64]$Contact,
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
[Parameter(Mandatory = $true)]
v1.8.4 (#50) * Fixing Interface Type parameter (#42) * Fixing #41 * Update `deploy.ps1` to remove trailing whitespaces from psd1 * Increase version to 1.7.3 * Fix location of whitespace cleanup in `deploy.ps1` * Device port support (#44) * Fixing #41 * Correct for OTBS * Start work on Front and Rear ports * Revert "Start work on Front and Rear ports" This reverts commit 257709fe2af5af5fbe4496b2d5b68481d80bf101. * Fixing #41 * Add-NetboxDCIMRearPort function * Revert "Revert "Start work on Front and Rear ports"" This reverts commit 4f6625af2dd95a5797da0efcff40774095ad2e95. * Fix incorrect parameter variable types * Parameter type adjustments * Create function to get tag information * Added Mark_Connected parameter * Add Set-NetboxDCIMRearPort function * Added Remove-NetboxDCIMRearPort function * Added validate pattern for Color parameter * Added Add-NetboxDCIMFrontPort function * Fixed param list missing Force parameter * Added Set-NetboxDCIMFrontPort function * Added Remove-NetboxDCIMFrontPort function * Init. functions for cables and cable terminations * Reformatting using OTBS Also working on defining tags by slug as an extra parameter, which appears only in Add-NetboxDCIMRearPort currently * Remove Tags_Slug parameter In hindsight implementing would create extra work that could be hard to maintain. Can be easily achieved outside of the function. * Update psproj * Fix braces * Update Postman for Netbox v3.4.5 * Update vscode settings * Update version 1.8.0 * Update psproj * Update `uint16` to `uint64` where applicable for #49 * dev v1.8.1 * More `uint64` updates for #49 * `[uint64]` updates * Add IPAMAddressRange functions * Move limit/offset parameters to end of list * Update psproj with IPAMAddressRange files * Remove whitespaces * Update version to 1.8.3 * Add Set-NetboxIPAMAddressRange * Remove incorrect parameter * Update version to 1.8.4 --------- Co-authored-by: SheffSix <jbeck1867@gmail.com> Co-authored-by: James Beck <jim@beck81.co.uk>
2023-11-07 10:30:05 -05:00
[uint64]$Role,
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
[ValidateSet('primary', 'secondary', 'tertiary', 'inactive', IgnoreCase = $true)]
[string]$Priority,
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
[switch]$Raw
)
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
begin {
# https://docs.netbox.dev/en/stable/features/contacts/
$AllowedContentTypes = @{
10 = "circuits.circuit"
7 = "circuits.provider"
19 = "dcim.device"
25 = "dcim.location"
29 = "dcim.manufacturer"
77 = "dcim.powerpanel"
20 = "dcim.rack"
30 = "dcim.region"
18 = "dcim.site"
92 = "dcim.sitegroup"
58 = "tenancy.tenant"
63 = "virtualization.cluster"
64 = "virtualization.clustergroup"
61 = "virtualization.virtualmachine"
}
}
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
process {
$Segments = [System.Collections.ArrayList]::new(@('tenancy', 'contact-assignment'))
$Method = 'POST'
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
if ($Content_Type -is [string]) {
# Need to convert this to an integer
$Content_Type = ($AllowedContentTypes.GetEnumerator() | Where-Object {
$_.Value -eq $Content_Type
}).Key
} elseif ($Content_Type -is [int]) {
if ($Content_Type -notin $($AllowedContentTypes).Keys) {
throw "Invalid content type defined"
}
} else {
throw "Invalid content type defined"
}
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
$URIComponents = BuildURIComponents -URISegments $Segments -ParametersDictionary $PSBoundParameters
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
$URI = BuildNewURI -Segments $URIComponents.Segments
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
if ($PSCmdlet.ShouldProcess($Address, 'Create new contact assignment')) {
InvokeNetboxRequest -URI $URI -Method $Method -Body $URIComponents.Parameters -Raw:$Raw
}
}
}