New-NBIPAMService
Since
v4.4.10.0
SYNOPSIS
Create a new service in Netbox
SYNTAX
New-NBIPAMService [-Name] <String> [[-Ports] <UInt16[]>] [[-Protocol] <String>] [[-Port_Mappings] <String[]>]
[[-Device] <UInt64>] [[-Virtual_Machine] <UInt64>] [[-IPAddresses] <UInt64[]>] [[-Description] <String>]
[[-Comments] <String>] [[-Custom_Fields] <Hashtable>] [[-Tags] <Object[]>] [-Raw]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Creates a new service object in Netbox. Services represent network services running on devices or virtual machines.
EXAMPLES
EXAMPLE 1
New-NBIPAMService -Name "HTTPS" -Ports @(443) -Protocol tcp -Device 1
Creates an HTTPS service on device 1
EXAMPLE 2
New-NBIPAMService -Name "DNS" -Ports @(53) -Protocol udp -Virtual_Machine 1
Creates a DNS service on VM 1
EXAMPLE 3
New-NBIPAMService -Name "DNS" -Port_Mappings 'tcp/53', 'udp/53' -Virtual_Machine 1
Netbox 4.7+: creates a DNS service listening on both TCP and UDP port 53
PARAMETERS
-Name
The name of the service (required)
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Ports
Array of port numbers. Required unless -Port_Mappings is used (Netbox 4.7+).
Type: UInt16[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Protocol
The protocol (tcp, udp, sctp). Defaults to tcp. Only sent together with -Ports.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Tcp
Accept pipeline input: False
Accept wildcard characters: False
-Port_Mappings
Netbox 4.7+: one or more 'protocol/port' strings (e.g. 'tcp/80', 'udp/53'). Lets a single service expose the same port on multiple protocols. Use this instead of -Ports/-Protocol, which Netbox 4.7 deprecates (still accepted; removed in Netbox 5.0). Ignored with a warning on older Netbox versions.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Device
The device ID this service runs on
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Virtual_Machine
The virtual machine ID this service runs on
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-IPAddresses
Array of IP address IDs associated with this service
Type: UInt64[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
A description of the service
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Comments
Additional comments
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Custom_Fields
A hashtable of custom fields
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tags
One or more tags to assign to this object (tag names or IDs).
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Raw
Return the raw API response
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
System.Management.Automation.PSObject
NOTES
AddedInVersion: v4.4.10.0