Jump to content

Template:Get: Difference between revisions

From pool
[unchecked revision][unchecked revision]
Content deleted Content added
m 1 revision imported
No edit summary
 
(34 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{#ifexist:Cli:{{{1}}}|
{{#ifexist:Cli:{{{1}}}|
<div class="mw-collapsible {{#if:{{{open|}}}||mw-collapsed}} force-toggle-float-left" data-collapsetext="-" data-expandtext="+" style="overflow:hidden; display: inline;">[[Cli:{{{1}}}|<span style="color: blue; display: inline;" title="{{#lst:Cli:{{{1}}}|description}} {{#if:{{#lst:Cli:{{{1}}}|version}}|{{#ifeq:{{#lst:Cli:{{{1}}}|version}}|07.0x.0y||(ver. {{#lst:Cli:{{{1}}}|version}} )}}|}}">'''{{{alt-text|{{{2|{{{1}}}}}}}}}'''</span>]]<div class="mw-collapsible-content {{{color|basic}}}" style="align: left;">{{{example|{{{3|{{#lst:Cli:{{{1}}}|{{{section|example}}}}}}}}}}}</div></div>{{#if:{{{inline|}}}||<br><br style="clear:both;">}}
{{#switch: open
| {{{4|}}} =
<div class="mw-collapsible force-toggle-float-left" data-collapsetext="-" data-expandtext="+" style="overflow:hidden; display: inline;">[[Cli:{{{1}}}|<span style="color: blue; display: inline;" title="{{#lst:Cli:{{{1}}}|description}} {{#if:{{#lst:Cli:{{{1}}}|version}}|{{#ifeq:{{#lst:Cli:{{{1}}}|version}}|07.0x.0y||(ver. {{#lst:Cli:{{{1}}}|version}} )}}|}}">'''{{{2}}}'''</span>]]<div class="mw-collapsible-content shell" style="align: left;">{{{3}}}</div></div>
| {{{3|}}} =
<div class="mw-collapsible force-toggle-float-left" data-collapsetext="-" data-expandtext="+" style="overflow:hidden; display: inline;">[[Cli:{{{1}}}|<span style="color: blue; display: inline;" title="{{#lst:Cli:{{{1}}}|description}} {{#if:{{#lst:Cli:{{{1}}}|version}}|{{#ifeq:{{#lst:Cli:{{{1}}}|version}}|07.0x.0y||(ver. {{#lst:Cli:{{{1}}}|version}} )}}|}}">'''{{{2}}}'''</span>]]<div class="mw-collapsible-content shell" style="align: left;">{{#lst:Cli:{{{1}}}|{{{sect|example}}}}}</div></div>
| {{{2|}}} =
<div class="mw-collapsible force-toggle-float-left" data-collapsetext="-" data-expandtext="+" style="overflow:hidden; display: inline;">[[Cli:{{{1}}}|<span style="color: blue; display: inline;" title="{{#lst:Cli:{{{1}}}|description}} {{#if:{{#lst:Cli:{{{1}}}|version}}|{{#ifeq:{{#lst:Cli:{{{1}}}|version}}|07.0x.0y||(ver. {{#lst:Cli:{{{1}}}|version}} )}}|}}">'''{{{1}}}'''</span>]]<div class="mw-collapsible-content shell" style="align: left;">{{#lst:Cli:{{{1}}}|{{{sect|example}}}}}</div></div>
| #default =
{{#ifeq: {{#sub:{{{1}}}|0|3}} | {{#sub:{{{2}}}|0|3}}
|
<div class="mw-collapsible mw-collapsed force-toggle-float-left" data-collapsetext="-" data-expandtext="+" style="display: inline;">[[Cli:{{{1}}}|<span style="color: blue; display: inline;" title="{{#lst:Cli:{{{1}}}|description}} {{#if:{{#lst:Cli:{{{1}}}|version}}|{{#ifeq:{{#lst:Cli:{{{1}}}|version}}|07.0x.0y||(ver. {{#lst:Cli:{{{1}}}|version}} )}}|}}">{{#if: {{{2|}}} |'''{{{2}}}'''|'''{{{1}}}'''}}</span>]]<div class="mw-collapsible-content shell noprint" style="align: left;">{{#if: {{{3|}}}|{{{3}}}|{{#lst:Cli:{{{1}}}|{{{sect|example}}}}} }}</div></div>{{#if:{{{nocr|}}}||<br><br style="clear:both;">}}
|
<div class="mw-collapsible mw-collapsed force-toggle-float-left" data-collapsetext="-" data-expandtext="+" style="display: inline;">[[Cli:{{{1}}}|<span style="color: blue; display: inline;" title="{{#lst:Cli:{{{1}}}|description}} {{#if:{{#lst:Cli:{{{1}}}|version}}|{{#ifeq:{{#lst:Cli:{{{1}}}|version}}|07.0x.0y||(ver. {{#lst:Cli:{{{1}}}|version}} )}}|}}">'''{{{1}}}'''</span>]]<div class="mw-collapsible-content shell noprint" style="align: left;">{{#if: {{{2|}}} |{{{2}}}|{{#lst:Cli:{{{1}}}|{{{sect|example}}}}} }}</div></div>{{#if:{{{nocr|}}}||<br><br style="clear:both;">}}
}}
}}
|
|
<div class="mw-collapsible {{#if:{{{open|}}}||mw-collapsed}} {{#if:{{{color|}}}|{{{color}}}}} force-toggle-float-left" data-collapsetext="-" data-expandtext="+" style="overflow:hidden; display: inline;"><span style="color: blue; display: inline;">'''{{{alt-text|{{{2|{{{1}}}}}}}}}'''</span><div class="mw-collapsible-content {{{color|basic}}}" style="align: left;">{{{example|{{{3|<pre>Need an Example</pre>}}}}}}</div></div>{{#if:{{{inline|}}}||<br><br style="clear:both;">}}
{{#switch: open
}}<noinclude>
| {{{4|}}} =
<div class="mw-collapsible force-toggle-float-left" data-collapsetext="-" data-expandtext="+" style="overflow:hidden; display: inline;"><span style="color: blue; display: inline;">'''{{{2}}}'''</span><div class="mw-collapsible-content shell" style="align: left;">{{{3}}}</div></div>
| {{{3|}}} =
<div class="mw-collapsible force-toggle-float-left" data-collapsetext="-" data-expandtext="+" style="overflow:hidden; display: inline;"><span style="color: blue; display: inline;">'''{{{2}}}'''</span><div class="mw-collapsible-content shell" style="align: left;"><pre>Need an Example</pre></div></div>
| {{{2|}}} =
<div class="mw-collapsible force-toggle-float-left" data-collapsetext="-" data-expandtext="+" style="overflow:hidden; display: inline;"><span style="color: blue; display: inline;">'''{{{1}}}'''</span><div class="mw-collapsible-content shell" style="align: left;"><pre>Need an Example</pre></div></div>
| #default =
{{#ifeq: {{#sub:{{{1}}}|0|3}} | {{#sub:{{{2}}}|0|3}}
|
<div class="mw-collapsible mw-collapsed force-toggle-float-left" data-collapsetext="-" data-expandtext="+" style="display: inline;"><span style="color: blue; display: inline;">{{#if: {{{2|}}} |'''{{{2}}}'''|'''{{{1}}}'''}}</span><div class="mw-collapsible-content shell noprint" style="align: left;">{{#if: {{{3|}}}|{{{3}}}|<pre>Need an Example</pre> }}</div></div>{{#if:{{{nocr|}}}||<br><br style="clear:both;">}}
|
<div class="mw-collapsible mw-collapsed force-toggle-float-left" data-collapsetext="-" data-expandtext="+" style="display: inline;"><span style="color: blue; display: inline;">'''{{{1}}}'''</span><div class="mw-collapsible-content shell noprint" style="align: left;">{{#if: {{{2|}}} |{{{2}}}|<pre>Need an Example</pre> }}</div></div>{{#if:{{{nocr|}}}||<br><br style="clear:both;">}}}}}}}}<noinclude>


Syntax Examples -
Only Specify the Command:
<pre>{{Get|command|sect=YourSectionName}}</pre>
Note: If you omit the sect=YourSectionName, by default will be used the section example. The sect option must be the last.


== Usage ==
{{Note|It is not necessary (but expected) when using this template that a page exists detailing the commands usage, it is from this page that the example and tool tip is taken, for the purpose of the examples below a test page has been created: [[Cli:Command show]]|info}}


Show alternative Text:
<pre>{{Get|command|alt text|sect=YourSectionName}}</pre>


{| class="wikitable"
|Only Specify the Command:
|-
|<pre>{{Get|Command show}}</pre>
|-
|{{Get|Command show}}
|}


Show alternative Text and specify code sample:
<pre>{{Get|command|alt text|&lt;pre&gt;sample code&lt;/pre&gt;|sect=YourSectionName}}</pre>


{| class="wikitable"
|Provide a different example :
|-
|<pre>{{Get|Command show|example=
&lt;pre&gt;
cli> dns show
# | id | addresses
----+------+-------------
1 | DNS1 | 10.24.27.42
| | 10.24.27.41
&lt;/pre&gt;}}</pre>
|-
|{{Get|Command show|example=
<pre>
cli> dns show
# | id | addresses
----+------+-------------
1 | DNS1 | 10.24.27.42
| | 10.24.27.41
cli>
</pre>}}
|}



With the Word "open" the code sample is shown by default:
{| class="wikitable"
<pre>{{Get|command|alt text|&lt;pre&gt;sample code&lt;/pre&gt;|open|sect=YourSectionName}}</pre></noinclude>
|Provide a different example, this time using syntaxhighlight and recoloring:
|-
|<pre>{{Get|Command show|color=black-white|example=
&lt;syntaxhighlight lang="text" highlight="4"&gt;
cli> dns show
# | id | addresses
----+------+-------------
1 | DNS1 | 10.24.27.42
| | 10.24.27.41
&lt;/syntaxhighlight&gt;}}</pre>
|-
|{{Get|Command show|color=black-white|example=
<syntaxhighlight lang="text" highlight="4">
cli> dns show
# | id | addresses
----+------+-------------
1 | DNS1 | 10.24.27.42
| | 10.24.27.41
cli>
</syntaxhighlight>}}
|}


{{Tip|The tool tips for version and description are take from the page in the Cli namespace having the same name as the command, you can spot them between tags like this:<br>
<code><nowiki><section begin=version />1.0.0.179<section end=version /></nowiki></code> and this:<br>
<code><nowiki><section begin=description />Description Goes Here!<section end=description /></nowiki></code>}}


{| class="wikitable"
|Specify alternative section of page to pull example from:
|-
|<pre>{{Get|Command show|section=hosts}}</pre>
|-
|{{Get|Command show|section=hosts}}
|}


{{Note|If you omit the section &#61;YourSectionName, by default the section called example will be used}}


{| class="wikitable"
|Show alternative Text:
|-
|<pre>{{Get|command show|volume show|color=blue-white}}</pre>
|-
|{{Get|command show|volume show|color=blue-white}}
|}


{| class="wikitable"
|Show alternative Text and specify code example, no need to use "example=" if the example is the 3rd paramater:
|-
|<pre>{{Get|command show|appliance show|
&lt;pre&gt;
cli> appliance show
# | id | name | service_tag | model | software_installed.release_version
----+----+-----------------------+-------------+------------------+------------------------------------
1 | A1 | PowerThor-appliance-1 | 59P42W2 | PowerStore 3000X | 1.0.0.1.3.720
cli> cluster show
# | name | management_address | storage_discovery_address | master_appliance_id | appliance_count | state
----+-----------+--------------------+---------------------------+---------------------+-----------------+------------
1 | PowerThor | 10.24.31.10 | 172.28.45.17 | A1 | 1 | Configured
cli>
&lt;/pre&gt;}}</pre>
|-
|{{Get|command show|appliance show|
<pre>
cli> appliance show
# | id | name | service_tag | model | software_installed.release_version
----+----+-----------------------+-------------+------------------+------------------------------------
1 | A1 | PowerThor-appliance-1 | 59P42W2 | PowerStore 3000X | 1.0.0.1.3.720
cli> cluster show
# | name | management_address | storage_discovery_address | master_appliance_id | appliance_count | state
----+-----------+--------------------+---------------------------+---------------------+-----------------+------------
1 | PowerThor | 10.24.31.10 | 172.28.45.17 | A1 | 1 | Configured
cli>
</pre>}}
|}


{{Caution|In order to format commands like the example below, with no additional line breaks, it is necessary to enclose the commands in a table or div, this page is a good example [[compiki:common commands]]}}



{| class="wikitable"
|Display several commands without additional line breaks:
|-
|
<pre>{{Get|command show|command one|&lt;pre&gt;command one sample code&lt;/pre&gt;|inline=1}}<br></pre><br>
<pre>{{Get|command show|command one|&lt;pre&gt;command two sample code&lt;/pre&gt;|inline=1}}<br></pre><br>
<pre>{{Get|command show|command one|&lt;pre&gt;command three sample code&lt;/pre&gt;|inline=1}}<br></pre><br>
|-
|
{{Get|command show|command one|<pre>command one sample code</pre>|inline=1}}<br>
{{Get|command show|command two|<pre>command two sample code</pre>|inline=1}}<br>
{{Get|command show|command three|<pre>command three sample code</pre>|inline=1}}<br>
|}


{{Note|The boilerplate page for documenting commands uses black and green coloring for the pre-formatted text, this can be set back to defaults by setting the color to basic like below|info-blue}}


{| class="wikitable"
|Change color and display open:
|-
|<pre>{{Get|Command show|open=1|color=basic}}</pre>
|-
|{{Get|Command show|open=1|color=basic}}
|}


{| class="wikitable"
|Open=1 using syntaxhighlight and recoloring:
|-
|<pre>{{Get|Command show|open=1|color=blue-white|example=
&lt;syntaxhighlight lang="text" highlight="4"&gt;
cli> dns show
# | id | addresses
----+------+-------------
1 | DNS1 | 10.24.27.42
| | 10.24.27.41
&lt;/syntaxhighlight&gt;}}</pre>
|-
|{{Get|Command show|color=blue-white|open=1|example=
<syntaxhighlight lang="text" highlight="4">
cli> dns show
# | id | addresses
----+------+-------------
1 | DNS1 | 10.24.27.42
| | 10.24.27.41
cli>
</syntaxhighlight>}}
|}


<templatedata>
{
"params": {
"1": {
"label": "Command Name",
"description": "Command Name, will like match page name describing this command",
"example": "volume show",
"type": "string",
"required": true
},
"alt-text": {
"label": "Alternative Command Description",
"description": "Either Alternate Description of Command or an Example",
"example": "volume show where status = offline",
"type": "string"
},
"example": {
"label": "Sample output",
"description": "An example output of runing this command",
"example": "<pre>volume show where status = offline</pre>",
"type": "string"
},
"color": {
"label": "Pre Color",
"description": "Color of Pre-formatted Example",
"example": "basic, black-green, blue-white, black-white, net, esx",
"type": "string"
},
"Section": {
"label": "Name of page section",
"description": "Name of page section where pre-formatted example is found",
"example": "example, example2",
"type": "string"
},
"open": {
"label": "Open",
"description": "Shows pre-formatted example as open by default",
"example": "1",
"type": "boolean"
},
"inline": {
"label": "Inline",
"description": "Removes all new lines / carraige returns",
"example": "1",
"type": "boolean"
}
},
"description": "Show a Command with a collapsed div containing an example",
"format": "inline"
}
</templatedata>[[Category:AutoDumpContentFromCommons]]</noinclude>

Latest revision as of 17:21, 5 May 2020

{{{1}}}
Need an Example




Usage

 
  
It is not necessary (but expected) when using this template that a page exists detailing the commands usage, it is from this page that the example and tool tip is taken, for the purpose of the examples below a test page has been created: Cli:Command show


Only Specify the Command:
{{Get|Command show}}
Command show
 
cli> volume show
 #  |                  id                  |         name         |  type   |       wwn       |   size    | protecti~
----+--------------------------------------+----------------------+---------+-----------------+-----------+-----------
  1 | 0008c12f-d24a-4117-bab9-2b7927e43b19 | Karin-Vol-Test4      | Primary | naa.68ccf09800~ | 42949672~ |
  2 | 05706c29-9743-4773-9a9d-320205f950a8 | Linux-Lab-VM-1-Vol-0 | Primary | naa.68ccf09800~ | 10737418~ |
  3 | 081946cf-86bb-4b40-baa1-15411288f325 | Linux-Lab-VM-3-005   | Primary | naa.68ccf09800~ | 10737418~ |
  4 | 0c0a4a8d-8c17-4c5c-b103-ce8062fe58ef | Karin-Vol-Test2      | Primary | naa.68ccf09800~ | 16106127~ |
  5 | 142b7bee-cc3e-4bc8-a58b-20582809bfa3 | Linux-Lab-VM-1-Vol-~ | Primary | naa.68ccf09800~ | 11059540~ |
  6 | 247187ee-55cb-4c73-ae5b-0c13fa734790 | Linux-Lab-VM-4-002   | Primary | naa.68ccf09800~ | 16106127~ |
  7 | 2ab636d6-3b43-43eb-a803-9f7551d9f5a2 | Karin-Vol-Test3      | Primary | naa.68ccf09800~ | 32212254~ |
  8 | 2d2ae6f3-5a94-4dca-9f68-62f54b0ff8ba | gslab3t1-vol5        | Primary | naa.68ccf09800~ | 26843545~ |
  9 | 3e3e0ed9-192e-4f1e-bcb4-5600842fc88d | Linux-Lab-VM-3-004   | Primary | naa.68ccf09800~ | 10737418~ |
 10 | 40187368-1bef-4925-9e46-a7019d24e7ee | Lab VMs              | Primary | naa.68ccf09800~ | 10844792~ |
 11 | 4126b8b7-fca8-46dd-8200-65389873304d | gslab3t1-vol3        | Primary | naa.68ccf09800~ | 26843545~ |
cli>



Provide a different example :
{{Get|Command show|example=
<pre>
cli> dns show
 #  |  id  |  addresses
----+------+-------------
  1 | DNS1 | 10.24.27.42
    |      | 10.24.27.41
</pre>}}
Command show
cli> dns show
 #  |  id  |  addresses
----+------+-------------
  1 | DNS1 | 10.24.27.42
    |      | 10.24.27.41
cli>



Provide a different example, this time using syntaxhighlight and recoloring:
{{Get|Command show|color=black-white|example=
<syntaxhighlight lang="text" highlight="4">
cli> dns show
 #  |  id  |  addresses
----+------+-------------
  1 | DNS1 | 10.24.27.42
    |      | 10.24.27.41
</syntaxhighlight>}}
Command show
cli> dns show
 #  |  id  |  addresses
----+------+-------------
  1 | DNS1 | 10.24.27.42
    |      | 10.24.27.41
cli>



 
Tip:   
The tool tips for version and description are take from the page in the Cli namespace having the same name as the command, you can spot them between tags like this:

<section begin=version />1.0.0.179<section end=version /> and this:

<section begin=description />Description Goes Here!<section end=description />


Specify alternative section of page to pull example from:
{{Get|Command show|section=hosts}}
Command show
 
cli> host show
 #  |                  id                  |      name      | description | os_type | host_group.name
----+--------------------------------------+----------------+-------------+---------+-----------------
  1 | 021f9529-171b-4adb-8a49-58cfa07ef4c4 | Linux-Lab-VM-3 |             | Linux   |
  2 | 30553818-2ac7-47ca-b52c-9e8d21012c36 | ESX2-Test      |             | ESXi    | EST-Test
  3 | 684006b2-08ac-472d-9a6b-cc9bd36dc9ab | Linux-Lab-VM-2 |             | Linux   |
  4 | 6ccec73e-d2af-4fcf-bd13-b92d1802b43a | ESX1-Test      |             | ESXi    | EST-Test
  5 | a4098f08-4b29-49cc-94a1-722922bf0d17 | Linux-Lab-VM-4 |             | Linux   |
  6 | ce7d89e5-fafe-410c-b257-afa5c42982b4 | ESX3-Test      |             | ESXi    | EST-Test
  7 | ddb081ea-bd85-48b7-bb4d-f0bfb2970b74 | Linux-Lab-VM-1 |             | Linux   |
cli>



 
Note:   
If you omit the section =YourSectionName, by default the section called example will be used


Show alternative Text:
{{Get|command show|volume show|color=blue-white}}
volume show
 
cli> volume show
 #  |                  id                  |         name         |  type   |       wwn       |   size    | protecti~
----+--------------------------------------+----------------------+---------+-----------------+-----------+-----------
  1 | 0008c12f-d24a-4117-bab9-2b7927e43b19 | Karin-Vol-Test4      | Primary | naa.68ccf09800~ | 42949672~ |
  2 | 05706c29-9743-4773-9a9d-320205f950a8 | Linux-Lab-VM-1-Vol-0 | Primary | naa.68ccf09800~ | 10737418~ |
  3 | 081946cf-86bb-4b40-baa1-15411288f325 | Linux-Lab-VM-3-005   | Primary | naa.68ccf09800~ | 10737418~ |
  4 | 0c0a4a8d-8c17-4c5c-b103-ce8062fe58ef | Karin-Vol-Test2      | Primary | naa.68ccf09800~ | 16106127~ |
  5 | 142b7bee-cc3e-4bc8-a58b-20582809bfa3 | Linux-Lab-VM-1-Vol-~ | Primary | naa.68ccf09800~ | 11059540~ |
  6 | 247187ee-55cb-4c73-ae5b-0c13fa734790 | Linux-Lab-VM-4-002   | Primary | naa.68ccf09800~ | 16106127~ |
  7 | 2ab636d6-3b43-43eb-a803-9f7551d9f5a2 | Karin-Vol-Test3      | Primary | naa.68ccf09800~ | 32212254~ |
  8 | 2d2ae6f3-5a94-4dca-9f68-62f54b0ff8ba | gslab3t1-vol5        | Primary | naa.68ccf09800~ | 26843545~ |
  9 | 3e3e0ed9-192e-4f1e-bcb4-5600842fc88d | Linux-Lab-VM-3-004   | Primary | naa.68ccf09800~ | 10737418~ |
 10 | 40187368-1bef-4925-9e46-a7019d24e7ee | Lab VMs              | Primary | naa.68ccf09800~ | 10844792~ |
 11 | 4126b8b7-fca8-46dd-8200-65389873304d | gslab3t1-vol3        | Primary | naa.68ccf09800~ | 26843545~ |
cli>



Show alternative Text and specify code example, no need to use "example=" if the example is the 3rd paramater:
{{Get|command show|appliance show|
<pre>
cli> appliance show
 #  | id |         name          | service_tag |      model       | software_installed.release_version
----+----+-----------------------+-------------+------------------+------------------------------------
  1 | A1 | PowerThor-appliance-1 | 59P42W2     | PowerStore 3000X | 1.0.0.1.3.720
cli> cluster show
 #  |   name    | management_address | storage_discovery_address | master_appliance_id | appliance_count |   state
----+-----------+--------------------+---------------------------+---------------------+-----------------+------------
  1 | PowerThor | 10.24.31.10        | 172.28.45.17              | A1                  |               1 | Configured
cli>
</pre>}}
appliance show
cli> appliance show
 #  | id |         name          | service_tag |      model       | software_installed.release_version
----+----+-----------------------+-------------+------------------+------------------------------------
  1 | A1 | PowerThor-appliance-1 | 59P42W2     | PowerStore 3000X | 1.0.0.1.3.720
cli> cluster show
 #  |   name    | management_address | storage_discovery_address | master_appliance_id | appliance_count |   state
----+-----------+--------------------+---------------------------+---------------------+-----------------+------------
  1 | PowerThor | 10.24.31.10        | 172.28.45.17              | A1                  |               1 | Configured
cli>



 
Caution:  
In order to format commands like the example below, with no additional line breaks, it is necessary to enclose the commands in a table or div, this page is a good example compiki:common commands


Display several commands without additional line breaks:
{{Get|command show|command one|<pre>command one sample code</pre>|inline=1}}<br>

{{Get|command show|command one|<pre>command two sample code</pre>|inline=1}}<br>

{{Get|command show|command one|<pre>command three sample code</pre>|inline=1}}<br>

command one
command one sample code

command two
command two sample code

command three
command three sample code


 
  The boilerplate page for documenting commands uses black and green coloring for the pre-formatted text, this can be set back to defaults by setting the color to basic like below


Change color and display open:
{{Get|Command show|open=1|color=basic}}
Command show
 
cli> volume show
 #  |                  id                  |         name         |  type   |       wwn       |   size    | protecti~
----+--------------------------------------+----------------------+---------+-----------------+-----------+-----------
  1 | 0008c12f-d24a-4117-bab9-2b7927e43b19 | Karin-Vol-Test4      | Primary | naa.68ccf09800~ | 42949672~ |
  2 | 05706c29-9743-4773-9a9d-320205f950a8 | Linux-Lab-VM-1-Vol-0 | Primary | naa.68ccf09800~ | 10737418~ |
  3 | 081946cf-86bb-4b40-baa1-15411288f325 | Linux-Lab-VM-3-005   | Primary | naa.68ccf09800~ | 10737418~ |
  4 | 0c0a4a8d-8c17-4c5c-b103-ce8062fe58ef | Karin-Vol-Test2      | Primary | naa.68ccf09800~ | 16106127~ |
  5 | 142b7bee-cc3e-4bc8-a58b-20582809bfa3 | Linux-Lab-VM-1-Vol-~ | Primary | naa.68ccf09800~ | 11059540~ |
  6 | 247187ee-55cb-4c73-ae5b-0c13fa734790 | Linux-Lab-VM-4-002   | Primary | naa.68ccf09800~ | 16106127~ |
  7 | 2ab636d6-3b43-43eb-a803-9f7551d9f5a2 | Karin-Vol-Test3      | Primary | naa.68ccf09800~ | 32212254~ |
  8 | 2d2ae6f3-5a94-4dca-9f68-62f54b0ff8ba | gslab3t1-vol5        | Primary | naa.68ccf09800~ | 26843545~ |
  9 | 3e3e0ed9-192e-4f1e-bcb4-5600842fc88d | Linux-Lab-VM-3-004   | Primary | naa.68ccf09800~ | 10737418~ |
 10 | 40187368-1bef-4925-9e46-a7019d24e7ee | Lab VMs              | Primary | naa.68ccf09800~ | 10844792~ |
 11 | 4126b8b7-fca8-46dd-8200-65389873304d | gslab3t1-vol3        | Primary | naa.68ccf09800~ | 26843545~ |
cli>



Open=1 using syntaxhighlight and recoloring:
{{Get|Command show|open=1|color=blue-white|example=
<syntaxhighlight lang="text" highlight="4">
cli> dns show
 #  |  id  |  addresses
----+------+-------------
  1 | DNS1 | 10.24.27.42
    |      | 10.24.27.41
</syntaxhighlight>}}
Command show
cli> dns show
 #  |  id  |  addresses
----+------+-------------
  1 | DNS1 | 10.24.27.42
    |      | 10.24.27.41
cli>



Show a Command with a collapsed div containing an example

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Command Name1

Command Name, will like match page name describing this command

Example
volume show
Stringrequired
Alternative Command Descriptionalt-text

Either Alternate Description of Command or an Example

Example
volume show where status = offline
Stringoptional
Sample outputexample

An example output of runing this command

Example
<pre>volume show where status = offline</pre>
Stringoptional
Pre Colorcolor

Color of Pre-formatted Example

Example
basic, black-green, blue-white, black-white, net, esx
Stringoptional
Name of page sectionSection

Name of page section where pre-formatted example is found

Example
example, example2
Stringoptional
Openopen

Shows pre-formatted example as open by default

Example
1
Booleanoptional
Inlineinline

Removes all new lines / carraige returns

Example
1
Booleanoptional