Skip to main content

Delete a VPN profile (vpnconf.delete)

Declaration​

ok = vpnconf.delete(nameOrId)

Parameters​

  • nameOrId
    String. Display name or VPNID. If multiple profiles share the same name, deletion is not deterministic. Use VPNID for precise deletion.

Returns​

  • ok
    Boolean. true on success; false on failure (usually because the specified profile does not exist).

Notes​

VPNID can be obtained with vpnconf.list.

Example​

local success = vpnconf.delete('A Test VPN')
if success then
    sys.alert('Operation succeeded')
else
    sys.alert('Operation failed. Does the target VPN exist?')
end

Note: Uses sys.alert

Delete all VPN profiles example​

-- Delete all VPNs
local vpnlist = vpnconf.list()
if vpnlist then
    for _,v in ipairs(vpnlist) do
        if (vpnconf.delete(v.VPNID)) then
            sys.log('Deleted: '..v.dispName..'('..v.VPNID..')')
        else
            sys.log('Cannot delete: '..v.dispName..'('..v.VPNID..')')
        end
    end
    sys.alert('Done!')
else
    sys.alert('Failed to get list')
end

Note: Uses sys.alert, sys.log