PlantUML Language specification nwdiag

       

Edit in DokuwikiEdit in AsciidocEdit in Markdown

ネットワーク図（nwdiag付き）

Edit in DokuwikiEdit in AsciidocEdit in Markdown

シンプルなネットワーク図

ネットワークの定義

@startnwdiag network dmz { address = "210.x.x.x/24" } @endnwdiag

ネットワーク上にいくつかの要素またはサーバーを定義する

@startnwdiag network dmz { address = "210.x.x.x/24" web01 [address = "210.x.x.1"]; web02 [address = "210.x.x.2"]; } @endnwdiag

完全な例

@startnwdiag network dmz { address = "210.x.x.x/24" web01 [address = "210.x.x.1"]; web02 [address = "210.x.x.2"]; } network internal { address = "172.x.x.x/24"; web01 [address = "172.x.x.1"]; web02 [address = "172.x.x.2"]; db01; db02; } @endnwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown

複数のアドレスを定義するケース

@startnwdiag network dmz { address = "210.x.x.x/24" // set multiple addresses (using comma) web01 [address = "210.x.x.1, 210.x.x.20"]; web02 [address = "210.x.x.2"]; } network internal { address = "172.x.x.x/24"; web01 [address = "172.x.x.1"]; web02 [address = "172.x.x.2"]; db01; db02; } @endnwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown

ノードのグルーピング

ネットワーク定義の中でグループを定義

@startnwdiag nwdiag { network Sample_front { address = "192.168.10.0/24"; // define group group web { web01 [address = ".1"]; web02 [address = ".2"]; } } network Sample_back { address = "192.168.20.0/24"; web01 [address = ".1"]; web02 [address = ".2"]; db01 [address = ".101"]; db02 [address = ".102"]; // define network using defined nodes group db { db01; db02; } } } @endnwdiag

ネットワーク定義の外でグループを定義

@startnwdiag nwdiag { // define group outside of network definitions group { color = "#FFAAAA"; web01; web02; db01; } network dmz { web01; web02; } network internal { web01; web02; db01; db02; } } @endnwdiag

一つのネットワークに複数のグループを定義

グループが２つの例

@startnwdiag nwdiag { group { color = "#FFaaaa"; web01; db01; } group { color = "#aaaaFF"; web02; db02; } network dmz { address = "210.x.x.x/24" web01 [address = "210.x.x.1"]; web02 [address = "210.x.x.2"]; } network internal { address = "172.x.x.x/24"; web01 [address = "172.x.x.1"]; web02 [address = "172.x.x.2"]; db01 ; db02 ; } } @endnwdiag

グループが３つの例

@startnwdiag nwdiag { group { color = "#FFaaaa"; web01; db01; } group { color = "#aaFFaa"; web02; db02; } group { color = "#aaaaFF"; web03; db03; } network dmz { web01; web02; web03; } network internal { web01; db01 ; web02; db02 ; web03; db03; } } @endnwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown

ネットワークとグループに対する拡張文法

ネットワーク

• アドレス (コンマ,区切り)
• 色
• 説明
• 形状

@startnwdiag nwdiag { network Sample_front { address = "192.168.10.0/24" color = "red" // define group group web { web01 [address = ".1, .2", shape = "node"] web02 [address = ".2, .3"] } } network Sample_back { address = "192.168.20.0/24" color = "palegreen" web01 [address = ".1"] web02 [address = ".2"] db01 [address = ".101", shape = database ] db02 [address = ".102"] // define network using defined nodes group db { db01; db02; } } } @endnwdiag

グループ

• 色
• 説明

@startnwdiag nwdiag { group { color = "#CCFFCC"; description = "Long group description"; web01; web02; db01; } network dmz { web01; web02; } network internal { web01; web02; db01 [address = ".101", shape = database]; } } @endnwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown

スプライトの使用

@startnwdiag !include <office/Servers/application_server> !include <office/Servers/database_server> nwdiag { network dmz { address = "210.x.x.x/24" // set multiple addresses (using comma) web01 [address = "210.x.x.1, 210.x.x.20", description = "<$application_server>\n web01"] web02 [address = "210.x.x.2", description = "<$application_server>\n web02"]; } network internal { address = "172.x.x.x/24"; web01 [address = "172.x.x.1"]; web02 [address = "172.x.x.2"]; db01 [address = "172.x.x.100", description = "<$database_server>\n db01"]; db02 [address = "172.x.x.101", description = "<$database_server>\n db02"]; } } @endnwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown

OpenIconicの使用

@startnwdiag nwdiag { group nightly { color = "#FFAAAA"; description = "<&clock> Restarted nightly <&clock>"; web02; db01; } network dmz { address = "210.x.x.x/24" user [description = "<&person*4.5>\n user1"]; // set multiple addresses (using comma) web01 [address = "210.x.x.1, 210.x.x.20", description = "<&cog*4>\nweb01"] web02 [address = "210.x.x.2", description = "<&cog*4>\nweb02"]; } network internal { address = "172.x.x.x/24"; web01 [address = "172.x.x.1"]; web02 [address = "172.x.x.2"]; db01 [address = "172.x.x.100", description = "<&spreadsheet*4>\n db01"]; db02 [address = "172.x.x.101", description = "<&spreadsheet*4>\n db02"]; ptr [address = "172.x.x.110", description = "<&print*4>\n ptr01"]; } } @endnwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown

複数のネットワークに一つのノードを定義

@startnwdiag nwdiag { // define group at outside network definitions group { color = "#7777FF"; web01; web02; db01; } network dmz { color = "pink" web01; web02; } network internal { web01; web02; db01 [shape = database ]; } network internal2 { color = "LightBlue"; web01; web02; db01; } } @endnwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown

ピア接続

@startnwdiag inet [shape = cloud]; inet -- router; network { router; web01; web02; } @endnwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown

ピア接続とグループ

グループ無し

@startnwdiag nwdiag { internet [ shape = cloud]; internet -- router; network proxy { router; app; } network default { app; db; } } @endnwdiag

1番目にグループを記述

@startnwdiag nwdiag { internet [ shape = cloud]; internet -- router; group { color = "pink"; app; db; } network proxy { router; app; } network default { app; db; } } @endnwdiag

2番目にグループを記述

@startnwdiag nwdiag { internet [ shape = cloud]; internet -- router; network proxy { router; app; } group { color = "pink"; app; db; } network default { app; db; } } @endnwdiag

3番目にグループを記述

@startnwdiag nwdiag { internet [ shape = cloud]; internet -- router; network proxy { router; app; } network default { app; db; } group { color = "pink"; app; db; } } @endnwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown

ネットワーク図にタイトル、ヘッダ、フッタ、キャプション、凡例を追加する

@startnwdiag header some header footer some footer title My title network inet { web01 [shape = cloud] } legend The legend end legend caption This is caption @endnwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown

影の有無

影有り(デフォルト)

@startnwdiag nwdiag { network nw { server; internet; } internet [shape = cloud]; } @endnwdiag

影無し

@startnwdiag <style> root { shadowing 0 } </style> nwdiag { network nw { server; internet; } internet [shape = cloud]; } @endnwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown

ネットワークの幅の変更

• 無し

@startnwdiag nwdiag { network NETWORK_BASE { dev_A [address = "dev_A" ] dev_B [address = "dev_B" ] } network IntNET1 { dev_B [address = "dev_B1" ] dev_M [address = "dev_M1" ] } network IntNET2 { dev_B [address = "dev_B2" ] dev_M [address = "dev_M2" ] } } @endnwdiag

• １番目のみ

@startnwdiag nwdiag { network NETWORK_BASE { width = full dev_A [address = "dev_A" ] dev_B [address = "dev_B" ] } network IntNET1 { dev_B [address = "dev_B1" ] dev_M [address = "dev_M1" ] } network IntNET2 { dev_B [address = "dev_B2" ] dev_M [address = "dev_M2" ] } } @endnwdiag

• １番目と２番目

@startnwdiag nwdiag { network NETWORK_BASE { width = full dev_A [address = "dev_A" ] dev_B [address = "dev_B" ] } network IntNET1 { width = full dev_B [address = "dev_B1" ] dev_M [address = "dev_M1" ] } network IntNET2 { dev_B [address = "dev_B2" ] dev_M [address = "dev_M2" ] } } @endnwdiag

• すべてに最大幅を指定

@startnwdiag nwdiag { network NETWORK_BASE { width = full dev_A [address = "dev_A" ] dev_B [address = "dev_B" ] } network IntNET1 { width = full dev_B [address = "dev_B1" ] dev_M [address = "dev_M1" ] } network IntNET2 { width = full dev_B [address = "dev_B2" ] dev_M [address = "dev_M2" ] } } @endnwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown

その他の内部ネットワーク

• アドレスまたは種類の指定無し

@startnwdiag nwdiag { network LAN1 { a [address = "a1"]; } network LAN2 { a [address = "a2"]; switch; } switch -- equip; equip -- printer; } @endnwdiag

• アドレスまたは種類の指定有り

@startnwdiag nwdiag { network LAN1 { a [address = "a1"]; } network LAN2 { a [address = "a2"]; switch [address = "s2"]; } switch -- equip; equip [address = "e3"]; equip -- printer; printer [address = "USB"]; } @endnwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown

グローバルスタイルの使用

スタイル無し(デフォルト)

@startnwdiag nwdiag { network DMZ { address = "y.x.x.x/24" web01 [address = "y.x.x.1"]; web02 [address = "y.x.x.2"]; } network Internal { web01; web02; db01 [address = "w.w.w.z", shape = database]; } group { description = "long group label"; web01; web02; db01; } } @endnwdiag

スタイル有り

@startnwdiag <style> nwdiagDiagram { network { BackGroundColor green LineColor red LineThickness 1.0 FontSize 18 FontColor navy } server { BackGroundColor pink LineColor yellow LineThickness 1.0 ' FontXXX only for description or label FontSize 18 FontColor #blue } arrow { ' FontXXX only for address FontSize 17 FontColor #red FontName Monospaced LineColor black } group { BackGroundColor cadetblue LineColor black LineThickness 2.0 FontSize 11 FontStyle bold Margin 5 Padding 5 } } </style> nwdiag { network DMZ { address = "y.x.x.x/24" web01 [address = "y.x.x.1"]; web02 [address = "y.x.x.2"]; } network Internal { web01; web02; db01 [address = "w.w.w.z", shape = database]; } group { description = "long group label"; web01; web02; db01; } } @endnwdiag

Edit in DokuwikiEdit in AsciidocEdit in Markdown

付録: ネットワーク図(nwdiag)上のすべての形状のテスト

@startnwdiag nwdiag { network Network { Actor [shape = actor] Agent [shape = agent] Artifact [shape = artifact] Boundary [shape = boundary] Card [shape = card] Cloud [shape = cloud] Collections [shape = collections] Component [shape = component] } } @endnwdiag

@startnwdiag nwdiag { network Network { Control [shape = control] Database [shape = database] Entity [shape = entity] File [shape = file] Folder [shape = folder] Frame [shape = frame] Hexagon [shape = hexagon] Interface [shape = interface] } } @enduml

@startnwdiag nwdiag { network Network { Label [shape = label] Node [shape = node] Package [shape = package] Person [shape = person] Queue [shape = queue] Stack [shape = stack] Rectangle [shape = rectangle] Storage [shape = storage] Usecase [shape = usecase] } } @endnwdiag

1. フォルダのラベルが重なって表示される
2. 六角形が表示されない

@startnwdiag nwdiag { network Network { Folder [shape = folder] Hexagon [shape = hexagon] } } @endnwdiag

@startnwdiag nwdiag { network Network { Folder [shape = folder, description = "Test, long long label\nTest, long long label"] Hexagon [shape = hexagon, description = "Test, long long label\nTest, long long label"] } } @endnwdiag