시퀀스 유스케이스 클래스 액티비티 컴포넌트 상태 객체 배치 타이밍 Regex Network Wireframe Archimate Gantt MindMap WBS EBNF JSON YAML
PlantUML Language specification nwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Network Diagram with nwdiag

A network diagram is a visual representation of a computer or telecommunications network. It illustrates the arrangement and interconnections of network components, including servers, routers, switches, hubs, and devices. Network diagrams are invaluable tools for network engineers and administrators to understand, set up, and troubleshoot networks. They are also essential for visualizing the structure and flow of data in a network, ensuring optimal performance and security.

nwdiag, developed by Takeshi Komiya, provides a streamlined platform to swiftly sketch network diagrams. We extend our gratitude to Takeshi for this innovative tool!

Given its intuitive syntax, nwdiag has been seamlessly integrated into PlantUML. The examples showcased here are inspired by the ones documented by Takeshi.

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Simple diagram

Define a network

To make the process more efficient, it is now possible to bypass the nwdiag { ... } wrapper. You can define your network directly within the PlantUML tags.

Standard approach:

Simplified approach: We have introduced this to simplify the syntax and reduce boilerplate code:

Define some elements or servers on a network

Full example

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Define multiple addresses

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Grouping nodes

Define group inside network definitions

Define group outside of network definitions

Define several groups on same network

Example with 2 group

[Ref. QA-12663]

Example with 3 groups

[Ref. QA-13138]

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Extended Syntax (for network or group)

Network

For network or network's component, you can add or change:

Group

For a group, you can add or change:

[Ref. QA-12056]

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Using Sprites

You can use all sprites (icons) from the Standard Library or any other library.

Use the notation <$sprite> to use a sprite, \n to make a new line, or any other Creole syntax.

[Ref. QA-11862]

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Using OpenIconic

You can also use the icons from OpenIconic in network or node descriptions.

Use the notation <&icon> to make an icon, <&icon*n> to multiply the size by a factor n, and \n to make a newline:

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Same nodes on more than two networks

You can use same nodes on different networks (more than two networks); nwdiag use in this case 'jump line' over networks.

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Peer networks

Peer networks are simple connections between two nodes, for which we don't use a horizontal "busbar" network

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Peer networks and group

Without group

Group on first

Group on second

Group on third

[Ref. Issue#408 and QA-12655]

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Add title, caption, header, footer or legend on network diagram

[Ref. QA-11303 and Common commands]

Edit in DokuwikiEdit in AsciidocEdit in Markdown
With or without shadow

With shadow (by default)

Without shadow

[Ref. QA-14516]

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Change width of the networks

You can change the width of the networks, especially in order to have the same full width for only some or all networks.

Here are some examples, with all the possibilities.

First example

Second example

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Other internal networks

You can define other internal networks (TCP/IP, USB, SERIAL,...).

[Ref. QA-12824]

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Using (global) style

Without style (by default)

With style

You can use style to change rendering of elements.

[Ref. QA-14479]

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Appendix: Test of all shapes on Network diagram (nwdiag)

FIXME
  1. Overlap of label for folder
  2. Hexagon shape is missing

FIXME