
PhpIPAM Subnets Search
CertifiedSearch phpIPAM subnets by CIDR
PhpIPAM Subnets Search
Search phpIPAM subnets by CIDR
Searches for subnets matching a given CIDR notation (e.g. 192.168.1.0/24).
Returns all subnets that match, across all sections visible to the authenticated user.
type: io.kestra.plugin.phpipam.ipam.subnet.SearchExamples
Search subnets by CIDR
id: phpipam_subnet_search
namespace: company.team
tasks:
- id: search_subnet
type: io.kestra.plugin.phpipam.ipam.subnet.Search
baseUrl: "https://ipam.example.com"
appId: myapp
auth:
appToken: "{{ secret('PHPIPAM_APP_TOKEN') }}"
cidr: "192.168.1.0/24"
Installation
Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:
kestractl plugins get io.kestra.plugin:plugin-phpipam --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
appId *string
Application ID
The API application identifier configured in phpIPAM under Administration → API.
It appears in the path segment /api/{appId}/.
auth *
Authentication
Provide either appToken for static App-token authentication,
or username + password to obtain a per-run session token.
Supplying both, or neither, raises a validation error.
io.kestra.plugin.phpipam.PhpipamAuthentication
Static App token
A token generated in the phpIPAM administration panel under Administration → API.
Sent to phpIPAM via the token request header.
Mutually exclusive with username / password.
Password
Password for the phpIPAM user. Must be provided together with username.
Username
phpIPAM username used to obtain a per-session token via POST /api/{appId}/user/.
Must be provided together with password.
Mutually exclusive with appToken.
baseUrl *string
Base URL of the phpIPAM instance
Root URL of the phpIPAM instance, e.g. https://ipam.example.com. No trailing slash needed.
cidr *string
CIDR to search
Subnet in CIDR notation, e.g. 192.168.1.0/24. The API returns subnets whose address and mask match.
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
{}1150insecureTls booleanstring
falseDisable TLS certificate validation
Set to true to trust all TLS certificates, including self-signed ones.
Intended for development or internal deployments only.
Outputs
subnets array
Matching subnets
Subnets whose address and mask match the given CIDR.
io.kestra.plugin.phpipam.ipam.model.Subnet
Usage
Address usage reported by phpIPAM for this subnet.
Only set by Get. It is null when the usage request fails.
io.kestra.plugin.phpipam.ipam.model.Subnet-SubnetUsage
Offline percent
Free hosts
Free hosts percent
Maximum hosts
Used addresses