NetBox AssignIpAddress
CertifiedEnterprise EditionAssign an IP address in NetBox
NetBox AssignIpAddress
Assign an IP address in NetBox
Creates an IP address and assigns it to a device or VM interface. Requires either address or prefixId (allocates the next available when using prefixId). Tags and custom fields are skipped when empty.
type: io.kestra.plugin.ee.netbox.ipam.AssignIpAddressExamples
Assign a management IP address.
id: assign_management_ip
namespace: company.team
tasks:
- id: assign_ip
type: io.kestra.plugin.ee.netbox.ipam.AssignIpAddress
url: "{{ secret('NETBOX_URL') }}"
token: "{{ secret('NETBOX_API_TOKEN') }}"
address: "10.100.1.45/24"
status: "active"
assignedObjectType: "dcim.interface"
assignedObjectId: "{{ outputs.register_new_switch.primary_interface_id }}"
dnsName: "switch-01.mgmt.example.com"
addressDescription: "Management interface IP"
role: "loopback"
tags:
- "management"
- "monitored"
Properties
token *Requiredstring
NetBox API token
Personal API token sent as Authorization: Token <value> for all requests.
url *Requiredstring
NetBox base URL
Base URL of the NetBox instance (for example: https://netbox.example.com). Must be reachable from the worker; trailing slash is optional.
address string
IP address
Explicit IP address to assign (for example: 10.0.0.10/24); required when prefixId is not provided.
addressDescription string
Description
Description of the IP address.
assignedObjectId integerstring
Assigned object ID
Assigned object ID referencing the interface.
assignedObjectType string
Assigned object type
Assigned object type (for example: dcim.interface or virtualisation.vminterface).
customFields object
Custom fields
Custom field values keyed by NetBox field name; ignored when empty.
dnsName string
DNS name
DNS name to associate with the IP address.
options Non-dynamic
HTTP client configuration
Optional HTTP client overrides (timeouts, TLS, proxies). Uses platform defaults when omitted.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
prefixId integerstring
Prefix ID
NetBox prefix ID used to allocate the next available IP when address is omitted.
role string
Role
Role for the IP address (for example: loopback, anycast).
status string
Status
IP address status accepted by NetBox (for example: active, reserved).
Outputs
address string
IP address
Assigned IP address.
id integer
IP address ID
Identifier of the assigned IP address returned by NetBox.
url string
IP address URL
API URL of the assigned IP address resource.
