NetBox IPAM AssignIpAddress
CertifiedEnterprise EditionAssign an IP address in NetBox
NetBox IPAM 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"
Installation
This Enterprise plugin requires an Enterprise image and access to the plugin registry. Install it with the following command:
kestractl plugins get io.kestra.plugin.ee:plugin-ee-netbox --compatible-for $KESTRA_VERSION For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.
For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.
Properties
token *string
NetBox API token
Personal API token sent as Authorization: Token <value> for all requests.
url *string
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.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150assignedObjectId 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
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.
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.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
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.
Retry strategy for HTTP requests.
retry is disabled by default.
Constant retry
Retry with a fixed delay between attempts.
durationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseExponential retry
Retry with exponentially increasing delays between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseRandom retry
Retry with a random delay within a configurable range between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalse[502,503,504]HTTP status codes that should be retried.
Used for idempotent methods (GET, HEAD) without their own entry in retryOnStatusCodesByMethod. Non-idempotent methods are never retried on a status code unless listed in retryOnStatusCodesByMethod. Defaults to 502, 503 and 504 for idempotent methods (GET, HEAD) only.
Per-HTTP-method overrides for which status codes should be retried.
Keys are HTTP methods (e.g. GET, POST). A method with no entry here falls back to retryOnStatusCodes. This lets a caller retry more broadly for safe, read-only methods (for example, every 5xx and a 429 for GET/HEAD) while keeping a narrower list for methods that write, where retrying a request that may have already been processed by the origin risks duplicating the effect. Example: {GET: [429, 500, 502, 503, 504], HEAD: [429, 500, 502, 503, 504]}.
["GET","HEAD"]HTTP methods for which any transport-level failure may be retried.
A transport-level failure is a connection or timeout error rather than an HTTP response (e.g. a read timeout or a connection reset mid-request). For a method listed here, any such failure is retried. Defaults to GET and HEAD HTTP methods.
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.
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.
