PhpIPAM Update
CertifiedUpdate a phpIPAM VLAN
PhpIPAM Update
Update a phpIPAM VLAN
Updates fields on an existing VLAN.
type: io.kestra.plugin.phpipam.ipam.vlan.UpdateExamples
Update a VLAN description
id: phpipam_vlan_update
namespace: company.team
tasks:
- id: update_vlan
type: io.kestra.plugin.phpipam.ipam.vlan.Update
baseUrl: "https://ipam.example.com"
appId: myapp
auth:
appToken: "{{ secret('PHPIPAM_APP_TOKEN') }}"
vlanId: "5"
resourceDescription: "Updated VLAN description"
Properties
appId *Requiredstring
Application ID
The API application identifier configured in phpIPAM under Administration → API.
It appears in the path segment /api/{appId}/.
auth *RequiredNon-dynamic
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 *Requiredstring
Base URL of the phpIPAM instance
Root URL of the phpIPAM instance, e.g. https://ipam.example.com. No trailing slash needed.
vlanId *Requiredstring
VLAN ID
Numeric ID of the VLAN to update.
insecureTls booleanstring
falseDisable TLS certificate validation
Set to true to trust all TLS certificates, including self-signed ones.
Intended for development or internal deployments only.
name string
Name
New name for the VLAN.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
resourceDescription string
Description
New description for the VLAN.
