NetBox Update

NetBox Update

Certified
Enterprise Edition

Update an existing NetBox device

Updates a NetBox device by ID using PATCH by default (partialUpdate=true) or PUT when disabled. Requires at least one field; otherwise the task fails. Tags and custom fields are skipped when empty.

yaml
type: io.kestra.plugin.ee.netbox.device.Update

Update device attributes.

yaml
id: update_device_status
namespace: company.team

tasks:
  - id: update_device
    type: io.kestra.plugin.ee.netbox.device.Update
    url: "{{ secret('NETBOX_URL') }}"
    token: "{{ secret('NETBOX_API_TOKEN') }}"
    deviceId: "{{ outputs.register_new_switch.id }}"
    status: "planned"
    position: 44
    rack: "rack-a02"
    addressDescription: "Moved to new rack during maintenance window"
    customFields:
      last_maintenance: "{{ now() }}"
    comments: "Device relocated as part of datacenter reorganization"
    tags:
      - "production"
      - "network"
      - "maintenance-2024"
Properties

Device ID

Identifier of the device to update.

NetBox API token

Personal API token sent as Authorization: Token <value> for all requests.

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.

Comments

Device comments field.

Custom fields

Custom field values keyed by NetBox field name; ignored when empty.

Description

Device description sent as addressDescription.

Device role

Device role slug or identifier accepted by NetBox.

Device type

Device type slug or identifier accepted by NetBox.

Rack face

Rack face; use front or rear.

Device name

New device name.

HTTP client configuration

Optional HTTP client overrides (timeouts, TLS, proxies). Uses platform defaults when omitted.

Definitions
allowFailedbooleanstring
Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray
SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

type*Requiredobject
passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

type*Requiredobject
tokenstring

The token for bearer token authentication.

type*Requiredobject
passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordDeprecatedstring

The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

basicAuthUserDeprecatedstring

The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

connectTimeoutDeprecatedstring
Formatduration

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeoutDeprecatedstring
Formatduration

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharsetstring
DefaultUTF-8

The default charset for the request.

enabledTcpExtendedKeepAlivebooleanstring
Defaulttrue

Whether 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.

followRedirectsbooleanstring
Defaulttrue

Whether redirects should be followed automatically.

logLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthDeprecatedinteger

The maximum content length of the response.

proxy

The proxy configuration.

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring
DefaultDIRECT
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

proxyAddressDeprecatedstring

The address of the proxy server.

proxyPasswordDeprecatedstring

The password for proxy authentication.

proxyPortDeprecatedinteger

The port of the proxy server.

proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernameDeprecatedstring

The username for proxy authentication.

readIdleTimeoutDeprecatedstring
Formatduration

The time allowed for a read connection to remain idle before closing it.

readTimeoutDeprecatedstring
Formatduration

The maximum time allowed for reading data from the server before failing.

ssl

The SSL request options

insecureTrustAllCertificatesbooleanstring

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.

timeout

The timeout configuration.

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring
DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

Defaulttrue

Partial update

Whether to PATCH the device (true, default) instead of PUT.

Reference (ref) of the pluginDefaults to apply to this task.

Position

Rack position in rack units.

Rack

Rack slug or identifier.

Site

Site slug or identifier.

Status

Device status value accepted by NetBox.

SubTypestring

Tags

Tag slugs to set on the device; ignored when empty.

Device ID

Identifier of the updated device returned by NetBox.

Device name

Device name returned by NetBox.

Device URL

API URL of the updated device resource.

More Plugins in this Category

OPA (Open Policy Agent)
OPA (Open Policy Agent)
Enterprise

Tasks to manage Open Policy Agent policies and decisions, including upload, evaluation, and partial evaluation.

Infrastructure

5 tasks

3 blueprints

Ansible
Ansible

Tasks that orchestrate Ansible playbooks from Kestra flows.

Infrastructure

1 tasks

17 blueprints