NetboxPS/Functions/Virtualization/VirtualMachine/New-NetboxVirtualMachine.ps1

66 lines
1.7 KiB
PowerShell
Raw Normal View History

2022-12-06 13:34:52 -05:00

2020-03-23 12:18:01 -04:00
function New-NetboxVirtualMachine {
[CmdletBinding(ConfirmImpact = 'low',
SupportsShouldProcess = $true)]
2020-03-23 12:18:01 -04:00
[OutputType([pscustomobject])]
param
(
[Parameter(Mandatory = $true)]
[string]$Name,
2020-03-23 12:18:01 -04: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]$Site,
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]$Cluster,
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]$Tenant,
2020-03-23 12:18:01 -04:00
[object]$Status = 'Active',
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,
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]$Platform,
2020-03-23 12:18:01 -04:00
[uint16]$vCPUs,
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]$Memory,
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]$Disk,
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]$Primary_IP4,
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]$Primary_IP6,
2020-03-23 12:18:01 -04:00
[hashtable]$Custom_Fields,
2020-03-23 12:18:01 -04:00
[string]$Comments
)
# $ModelDefinition = $script:NetboxConfig.APIDefinition.definitions.WritableVirtualMachineWithConfigContext
# # Validate the status against the APIDefinition
# if ($ModelDefinition.properties.status.enum -inotcontains $Status) {
# throw ("Invalid value [] for Status. Must be one of []" -f $Status, ($ModelDefinition.properties.status.enum -join ', '))
# }
#$PSBoundParameters.Status = ValidateVirtualizationChoice -ProvidedValue $Status -VirtualMachineStatus
if ($PSBoundParameters.ContainsKey('Cluster') -and (-not $PSBoundParameters.ContainsKey('Site'))) {
throw "You must specify a site ID with a cluster ID"
}
2020-03-23 12:18:01 -04:00
$Segments = [System.Collections.ArrayList]::new(@('virtualization', 'virtual-machines'))
2020-03-23 12:18:01 -04:00
$URIComponents = BuildURIComponents -URISegments $Segments -ParametersDictionary $PSBoundParameters
2020-03-23 12:18:01 -04:00
$URI = BuildNewURI -Segments $URIComponents.Segments
if ($PSCmdlet.ShouldProcess($name, 'Create new Virtual Machine')) {
InvokeNetboxRequest -URI $URI -Method POST -Body $URIComponents.Parameters
}
}