PhpIPAM Update

PhpIPAM Update

Certified

Update a phpIPAM VRF

Updates fields on an existing VRF.

yaml
type: io.kestra.plugin.phpipam.ipam.vrf.Update

Update a VRF description

yaml
id: phpipam_vrf_update
namespace: company.team
tasks:
  - id: update_vrf
    type: io.kestra.plugin.phpipam.ipam.vrf.Update
    baseUrl: "https://ipam.example.com"
    appId: myapp
    auth:
      appToken: "{{ secret('PHPIPAM_APP_TOKEN') }}"
    vrfId: "2"
    resourceDescription: "Updated VRF description"
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.

VRF ID

Numeric ID of the VRF to update.

Defaultfalse

Disable TLS certificate validation

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

Name

New name for the VRF.

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

Route distinguisher

New Route Distinguisher.

Description

New description.