New-NBIPAMService
Since
v4.4.10.0
SYNOPSIS
Create a new service in Netbox
SYNTAX
New-NBIPAMService [-Name] <String> [-Ports] <UInt16[]> [[-Protocol] <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
PARAMETERS
-Name
The name of the service (required)
```yaml 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)
```yaml Type: UInt16[] Parameter Sets: (All) Aliases:
Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Protocol
The protocol (tcp, udp, sctp). Defaults to tcp.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 3 Default value: Tcp Accept pipeline input: False Accept wildcard characters: False ```
-Device
The device ID this service runs on
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 4 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Virtual_Machine
The virtual machine ID this service runs on
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 5 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-IPAddresses
Array of IP address IDs associated with this service
```yaml Type: UInt64[] Parameter Sets: (All) Aliases:
Required: False Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Description
A description of the service
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Comments
Additional comments
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Custom_Fields
A hashtable of custom fields
```yaml Type: Hashtable Parameter Sets: (All) Aliases:
Required: False Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Tags
{{ Fill Tags Description }}
```yaml Type: Object[] Parameter Sets: (All) Aliases:
Required: False Position: 10 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Raw
Return the raw API response
```yaml 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.
```yaml 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.
```yaml 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 }}
```yaml 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