$api_crypt_encryption_library = "mcrypt";
Once installed, successfully, go to your "Configuration Manager" (from the "Admin" page, choose "Configuration Settings"),
and put the API parameters (plus some others...)
You are now ready to use the provided syntax in your //DokuWiki// pages.
===== Syntax =====
==== General ====
This plugin offers at least three [[wp>Case_sensitivity|case-insensitive]] syntaxes:
* a new XML [[wp>HTML_element#Elements_vs._tags|tag]] like: @phpipam ... @@
* a new //DokuWiki// [[wiki:syntax#macros|macro]] like: ~phpipam ... ~~
The call, to produce an effect, must have some pair ''[[wp>HTML_attribute|parameters_or_attributes]]=value'' set.
Following sub-sections will list available attributes and their meaning.
:!: All other pairs parameter=value (i.e. parameters not listed) are passed to the API to be used as filter; so be careful...
==== Direct ====
A first category of attributes are those related to the [[wp>IP_address_management|IPAM]] object.
^ attribute name ^ value type ^ query for ^ list of ^
| ''sid'' or ''nid'' or just ''id'' or ''num'' \\ (or longer forms: ''subnetid'' or ''networkid'' or ''number'') | integer | [[wp>Subnetwork|subnet]] index | hosts |
| ''vid'' or ''vlanid'' | integer | [[wp>Virtual_LAN|VLAN]] index | subnets |
| ''did'' or ''deviceid'' | integer | Device index | hosts |
| ''cidr'' or ''net'' (or longer forms ''subnet'' or ''network'') or ''ret'' | [[wp>Classless_Inter-Domain_Routing#CIDR_notation|CIDR notation]] | [[wp>Subnetwork|subnet]] address | hosts |
| ''vlan'' or ''[[https://docs.microsoft.com/en-us/azure/virtual-network/manage-virtual-network|vnet]]'' or ''[[https://aws.amazon.com/vpc/|vpc]]'' or ''[[https://techexe.net/vlan-and-vdom/|vdom]]'' | integer | [[wp>Virtual_LAN|VLAN]] number | subnets |
| ''lid'' or ''locationid'' or ''placeid'' or ''siteid'' | integer | Location index | hosts |
| ''loc'' or ''location'' or ''place'' or ''site'' | integer | Location index | subnets |
| ''tid'' or ''tagid'' or ''statusid'' | integer | Tag (address status) index | hosts |
| ''eid'' or ''rackid'' or ''cabinetid'' | integer | [[wp>19-inch_rack|Enclosure rack]] index | devices |
There's a parameter ''fmt'' or ''format'' that will direct the output. \\
For each object (subnet/device/VLAN/location) there's
* a presentation heading (when the format parameter is either ''head'' or ''both'')
* a list (when the format parameter is either ''list'' or ''both'') of addresses in most cases
There's an exception for [[wp>19-inch_rack|racks]]... where the list of enclosed devices is always displayed
--block representation like with plugins of [[plugin:advrack|Ashraff Hasson (advrack)]] or [[plugin:rack|Tyler Bletsch (rack)]]
from which bunch of code is stolen from-- and ''format'' can be one of ''front'' or ''back'' or default ''both''.
==== Indirect ====
A second category of attributes take index of an object to produce the output to some other object previously discussed.
^ attribute name ^ source object index ^ destination object ^
| ''s2n'' or ''s2s'' | Section | SubNets |
| ''f2n'' or ''f2s'' | master-[[wp>Subnetwork|subnet]] or [[wp>Directory_(computing)#Folder_metaphor|Folder]] (of course [[wp>Virtual_folder|virtual]]) | SubNets |
| ''v2n'' or ''v2s'' | [[wp>Virtual_LAN|Virtual layer 2 network]] | SubNets |
| ''n2n'' or ''n2s'' | [[wp>Virtual_LAN|virtual Network]] Number! | SubNets |
| ''l2n'' or ''l2s'' | Location | SubNets |
| ''d2n'' or ''d2s'' | Device | SubNets |
| ''r2n'' or ''r2s'' | [[wp>Virtual_routing_and_forwarding|virtual Routing and forwarding]] | SubNets |
| ''t2d'' | device Type | Devices |
| ''l2d'' | Location | Devices |
| ''e2d'' | [[wp>19-inch_rack|Enclosure rack]] | Devices |
| ''l2e'' | Location | Enc. racks |
| ''d2e'' | Device | Enc. racks |
| ''22v'' | [[wp>Layer_2_Forwarding_Protocol|layer 2 domain]] | Vlan |
I think all possible cases are covered so, otherwise let me know.
==== Filtering ====
But be careful: unrecognized attributes/parameters are passed to the API.
So, if you pass for example ''foo=bah'', it will fail!
But there're some additional attributes that can be used to refine results.
Two useful mentioned in the documentation are ''filter_by'' with a field name and ''filter_value''.
In order to use them, you should set the required index to ''0'' (zero.)
Let's illustrate that.
When you know that the location index is ten, that's simple as:
┌─────────────────────────────────────────────────────────────────┐
│ main box │
│ ┌─────────────────────────────────────────────────────────────┐ │
│ │ title box │ │
│ └────
────────────────────────────────────────────────────────┘ │
│ ┌────────────────────────────────────────────────────────────┐ │
│ │ presentation box (depends setting) │ │
│ └───────────────────────────────────────────────────────────┘ │
│ ┌────────────────────────────────────────────────────────────┐ │
│ │ listing box (depends setting) │ │
│ └───────────────────────────────────────────────────────────┘ │
└────────────────────────────────────────────────────────────────┘
Position and styling of the output boxes can be done with simple CSS. \\
You now can style those boxes with CSS in your ''[[devel:css#user_styles|
┌───────────────────────────────┐
│ main box │
│ ┌─────────────────────────────────────────┐ │
│ │ title │ │
│ └────
────────────────────────────────────────────────────────┘ │
│ ┌─────────────────────────────┐ │
│ │ presentation box (depends setting) │ │
│ │ ┌─────────────────────┐ │ │
│ │ └─────────────────────┘ │ │
│ │ ┌─────────────────────┐ │ │
│ │ └─────────────────────┘ │ │
│ └───────────────────────────────────────────────────────────┘ │
│ ┌─────────────────────────────────────┐ │
│ │ listing box (depends setting) │ │
│ │ ┌─────────────────────┐ │ │
│ │ └─────────────────────┘ │ │
│ │ ┌─────────────────────┐ │ │
│ │ └─────────────────────┘ │ │
│ └───────────────────────────────────────────────────────────┘ │
└────────────────────────────────────────────────────────────────┘
For example, you may have things like:
phpipam {
background-color: aliceblue;
color: black;
}
phpipam_tag-1 {
background-color: #f59c99;
color: inherit;
}
phpipam_tag-2 {
background-color: #a9c9a4;
color: inherit;
}
phpipam_tag-3 {
background-color: #9ac0cd;
color: #efefef;
}
phpipam_tag-4 {
background-color: #c9c9c9;
color: #fefefe;
}
They may have some other classes depending on the configuration.
For example, for tables, they are also ''rowX'' and ''colX'' etc.
==== Translation Support ====
If you use the [[translation]] plugin, you might want to use the labels and keywords in different languages.
If you only want to use English field names while having them displayed in your language, you can also follow these instructions.
To create new translations, create a file in ''
After creating or modifying ''phpipam-plugin.php'' file, please update your //DokuWiki// configuration to refresh cache
''%%start?do=admin&page=config%%'', otherwise modifications are not taken into account.
==== Others ====
**Important!** These are //hacks// -- there is no guarantee they'll always work, and they will **not** survive updates.
If it breaks you get to keep the pieces. :-)
===== Code evolution =====
This plugin is opensource.
==== Bugs, Feature Requests and Patches ====
Please submit bugs and feature requests in the [[https://github.com/gilcot/dwpi/issues|issue tracker on GitHub]].
Patches should be sent [[https://www.artima.com/weblogs/viewpost.jsp?thread=164293|unified diff format]] or as [[https://git-scm.com/docs/git-format-patch|Git patches]] against the master branch.\\
Or even better: [[https://help.github.com/articles/fork-a-repo/|fork the repository at GitHub]] and [[https://help.github.com/articles/creating-a-pull-request-from-a-fork/|send a merge request]].
==== Missing Features & To Do ====
This plugin came to life because a company I'm working is switching from //DokuWiki// (for our department) and others (some department use spreadsheet and some other department another tool) to a common [[wp>IP_address_management|IPAM]]. As our wiki is for general infrastructure documentation with some subnet addresses listed here and there, I wrote a this plugin in order to avoid switching between tabs and ease migration... \\
So, the first implementations is what is given by ''sid''/''nid'' or (added later) ''net''/''cidr'' attributes.
But later we had [[wp>Dynamic_Host_Configuration_Protocol|DHCP]] addresses we'd like to show in compressed form (whereas maybe some other users would like to "hide" some other tag.) Unfortunately I don't have time to incorporate it.
When we updated to version 1.3, we've been pleased by the locations and racks modules.
This plugin is then rewritten with newer attributes ''lid'', ''eid'' (renamed so when I've added VRF and VLAN later), ''did'', ''l2s''/''l2n'', ''l2e'', ''e2d'', ''l2d'', ''l2e'', ''d2e''.
However, having to deal with numeric identifiers is not so friendly. A workaround is provided by the support of filters.
Currently, API doesn't offer a simpler way to do that; and there's no partial search...
Also, later, before public release, I've added the other attributes: ''t2n''/''t2s'', ''t2d'', ''s2n''/''s2s'', ''f2n''/''f2s'', ''r2n''/''r2s'', ''vid'', ''s2v'', ''22v''. Most of them are [[wp>Proof_of_concept#Software_development|PoC]] and they may be room for improvement.
Last but not least; many CSS classes are added, but a consistency check must be done. \\
Despite that, there're some inline styles here and there: a clean should be performed...
I don't plan to add some other things ; there's already enough to play with. \\
That doesn't mean there aren't ideas in the hood (nat, patch panels, circuits, etc.)
To be followed...
==== Other Questions ====
If you still have questions, search the forum, and if it hasn't been asked before ask your question there. \\
:!: Please leave bug reports on [[https://github.com/gilcot/dwpi/issues|GitHub's issue tracker]].
==== Latest Commits ====
{{rss>https://github.com/gilcot/dwpi/commits/master.atom date}}