SolarWinds Orion ListDhcpScopes

SolarWinds Orion ListDhcpScopes

Certified
Enterprise Edition

List DHCP scopes in SolarWinds Orion IPAM

Retrieves IPAM.DhcpScope records via SWQL. Optionally filter by subnet ID.

yaml
type: io.kestra.plugin.ee.solarwinds.ipam.dhcpscope.ListDhcpScopes

List all DHCP scopes.

yaml
id: list_dhcp_scopes
namespace: company.team

tasks:
  - id: list
    type: io.kestra.plugin.ee.solarwinds.ipam.dhcpscope.ListDhcpScopes
    host: "{{ secret('SOLARWINDS_HOST') }}"
    username: "{{ secret('SOLARWINDS_USER') }}"
    password: "{{ secret('SOLARWINDS_PASSWORD') }}"
    fetchType: FETCH
Properties

SolarWinds Orion host

Hostname or IP address of the SolarWinds Orion server. Must be reachable from the Kestra worker.

Password

Password for the SolarWinds Orion account. Masked in logs.

Username

SolarWinds Orion account used for HTTP Basic authentication.

DefaultFETCH
Possible Values
FETCH_ONEFETCHSTORENONE

Fetch type

Controls how results are returned:

  • FETCH: returns all rows inline.
  • STORE: writes results to Kestra internal storage.
  • FETCH_ONE: returns the first row inline.
  • NONE: discards results.

HTTP client configuration

Optional HTTP client overrides such as timeouts or proxy settings. 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.

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

Default17778

SWIS port

TCP port of the SolarWinds Information Service REST endpoint. Defaults to 17778.

Subnet ID filter

Restricts results to DHCP scopes associated with this subnet.

Defaulttrue

Verify SSL certificate

When false, disables TLS certificate verification. Useful when Orion uses a self-signed certificate. Defaults to true (secure).

SubTypeobject

DHCP scope rows (FETCH / FETCH_ONE mode)

Total number of DHCP scopes returned

Formaturi

Internal storage URI containing results as ION (STORE mode)