ESC
Ask Kestra AI
ESC
Kestra AI

Hi! I'm your Kestra AI assistant.
Ask me anything about workflows.

EXAMPLE QUESTIONS

How to receive an alert on flow failure?
How to write expression for previous tasks outputs?
How to add secrets?

PhpIPAM List

PhpIPAM List

Certified

List subnets in a phpIPAM section

Returns all subnets belonging to the specified section.

yaml
type: io.kestra.plugin.phpipam.ipam.subnet.List

List subnets in a section

yaml
id: phpipam_subnet_list
namespace: company.team
tasks:
  - id: list_subnets
    type: io.kestra.plugin.phpipam.ipam.subnet.List
    baseUrl: "https://ipam.example.com"
    appId: myapp
    auth:
      appToken: "{{ secret('PHPIPAM_APP_TOKEN') }}"
    sectionId: "1"
Properties

Application ID

The API application identifier configured in phpIPAM under Administration → API. It appears in the path segment /api/{appId}/.

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.

Definitions
appTokenstring

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.

passwordstring

Password

Password for the phpIPAM user. Must be provided together with username.

usernamestring

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.

Base URL of the phpIPAM instance

Root URL of the phpIPAM instance, e.g. https://ipam.example.com. No trailing slash needed.

Section ID

Numeric ID of the section whose subnets to list.

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

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

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

Fetch type

Controls how results are returned:

  • FETCH (default): return the full list in subnets + total count.
  • FETCH_ONE: return only the first subnet in subnet + total count.
  • STORE: write all subnets as newline-delimited JSON to Kestra internal storage, return uri + total count.
  • NONE: return only the total count, no rows.
Defaultfalse

Disable TLS certificate validation

Set to true to trust all TLS certificates, including self-signed ones. Intended for development or internal deployments only.

Subnet

First subnet returned. Populated for FETCH_ONE fetch type.

Definitions
descriptionstring
editDatestring
idstring
maskstring
masterSubnetIdstring
nameserverIdstring
permissionsstring
sectionIdstring
showNamestring
subnetstring
usage
Offline_percentstring
freehostsstring
freehosts_percentstring
maxhostsstring
usedstring
vlanIdstring
vrfIdstring

Subnets

Subnets belonging to the section. Populated for FETCH fetch type.

Definitions
descriptionstring
editDatestring
idstring
maskstring
masterSubnetIdstring
nameserverIdstring
permissionsstring
sectionIdstring
showNamestring
subnetstring
usage
Offline_percentstring
freehostsstring
freehosts_percentstring
maxhostsstring
usedstring
vlanIdstring
vrfIdstring
Default0

Total

Total number of subnets returned by the API.

Formaturi

URI

Internal storage URI of the newline-delimited JSON file. Populated for STORE fetch type.

More Plugins in this Category

F5 BIG-IP (EE)
F5 BIG-IP
Enterprise

Manage F5 BIG-IP LTM nodes, pools, pool members, virtual servers, and health monitors via the iControl REST API.

Infrastructure

29 tasks

Syslog (EE)
Syslog
Enterprise

Export Kestra execution and audit logs to a Syslog collector or SIEM in CEF format over UDP, TCP, or TLS.

Infrastructure

1 tasks