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.

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.

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

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

VMware (EE)
VMware
Enterprise

Tasks that automate VMware vSphere operations within Kestra workflows.

Infrastructure

33 tasks

3 blueprints

Canonical (EE)
Canonical
Enterprise

Tasks to interact with Canonical services, enabling automation and infrastructure management through API-driven workflows.

CloudInfrastructure

5 tasks