PhpIPAM Create

PhpIPAM Create

Certified

Create a phpIPAM VLAN

Creates a new VLAN in phpIPAM.

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

Create a VLAN

yaml
id: phpipam_vlan_create
namespace: company.team
tasks:
  - id: create_vlan
    type: io.kestra.plugin.phpipam.ipam.vlan.Create
    baseUrl: "https://ipam.example.com"
    appId: myapp
    auth:
      appToken: "{{ secret('PHPIPAM_APP_TOKEN') }}"
    name: "MGMT"
    number: "100"
    description: "Management VLAN"
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.

VLAN name

Name for the new VLAN.

VLAN number

802.1Q VLAN tag number (1–4094).

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.

Description

Optional description.

Created VLAN ID

Numeric ID of the newly created VLAN.