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

80 lines
2.3 KiB
PowerShell
Raw Normal View History

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

function New-NetboxContactAssignment {
2023-02-16 09:47:00 -05:00
<#
.SYNOPSIS
Create a new contact role assignment in Netbox
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.DESCRIPTION
Creates a new contact role assignment in Netbox
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.PARAMETER Content_Type
The content type for this assignment.
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.PARAMETER Object_Id
ID of the object to assign.
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.PARAMETER Contact
ID of the contact to assign.
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.PARAMETER Role
ID of the contact role to assign.
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.PARAMETER Priority
Piority of the contact assignment.
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 -Content_Type 'dcim.location' -Object_id 10 -Contact 15 -Role 10 -Priority 'Primary'
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
.NOTES
Valid content types: https://docs.netbox.dev/en/stable/features/contacts/#contacts_1
2023-02-16 09:47:00 -05:00
#>
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)]
[ValidateSet('circuits.circuit', 'circuits.provider', 'circuits.provideraccount', 'dcim.device', 'dcim.location', 'dcim.manufacturer', 'dcim.powerpanel', 'dcim.rack', 'dcim.region', 'dcim.site', 'dcim.sitegroup', 'tenancy.tenant', 'virtualization.cluster', 'virtualization.clustergroup', 'virtualization.virtualmachine', IgnoreCase = $true)]
[string]$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 {
$Method = 'POST'
2023-02-16 09:47:00 -05:00
}
2023-02-24 15:14:04 -05:00
2023-02-16 09:47:00 -05:00
process {
$Segments = [System.Collections.ArrayList]::new(@('tenancy', 'contact-assignments'))
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
if ($PSCmdlet.ShouldProcess($Content_Type, 'Create new contact assignment')) {
2023-02-16 09:47:00 -05:00
InvokeNetboxRequest -URI $URI -Method $Method -Body $URIComponents.Parameters -Raw:$Raw
}
}
}