PhpIPAM List

PhpIPAM List

Certified

List phpIPAM VLANs

Returns all VLANs visible to the authenticated user.

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

List all VLANs

yaml
id: phpipam_vlan_list
namespace: company.team
tasks:
  - id: list_vlans
    type: io.kestra.plugin.phpipam.ipam.vlan.List
    baseUrl: "https://ipam.example.com"
    appId: myapp
    auth:
      appToken: "{{ secret('PHPIPAM_APP_TOKEN') }}"
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.

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

Fetch type

Controls how results are returned:

  • FETCH (default): return the full list in vlans + total count.
  • FETCH_ONE: return only the first VLAN in vlan + total count.
  • STORE: write all VLANs 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.

Default0

Total

Total number of VLANs returned by the API.

Formaturi

URI

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

VLAN

First VLAN returned. Populated for FETCH_ONE fetch type.

Definitions
descriptionstring
domainIdstring
editDatestring
namestring
numberstring
vlanIdstring

VLANs

All VLANs returned by the phpIPAM API. Populated for FETCH fetch type.

Definitions
descriptionstring
domainIdstring
editDatestring
namestring
numberstring
vlanIdstring

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