ServerView Virutal-IO Manager CLI V3 - Fujitsumanuals.ts.fujitsu.com/file/12320/sv-viomcli-en.pdf · – The VIOM CLI server which is designed as a platform-independent JAVA ... The

Reference Manual - English

FUJITSU Software ServerView Suite

ServerView Virtual-IO Manager CLI V3.8Command Line Interface

February 2018

Comments… Suggestions… Corrections…The User Documentation Department would like toknow your opinion of this manual. Your feedback helpsus optimize our documentation to suit your individual needs.

Feel free to send us your comments by e-mail to [email protected].

Certified documentation according to DIN EN ISO 9001:2008To ensure a consistently high quality standard anduser-friendliness, this documentation was created tomeet the regulations of a quality management system which complies with the requirements of the standardDIN EN ISO 9001:2008.

cognitas. Gesellschaft für Technik-Dokumentation mbHwww.cognitas.de

Copyright and Trademarks

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

015

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

vor

Copyright 2017 FUJITSU LIMITED

All rights reserved.Delivery subject to availability; right of technical modifications reserved.

All hardware and software names used are trademarks of their respective manufacturers.

mailto:[email protected]

http://www.cognitas.de

Contents

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1.1 What‘s new . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

1.2 ServerView Suite link collection . . . . . . . . . . . . . . . . . 8

1.3 Documentation for ServerView Suite . . . . . . . . . . . . . . 9

2 Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

3 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

4 Installation and uninstallation . . . . . . . . . . . . . . . . . 15

4.1 Installation process . . . . . . . . . . . . . . . . . . . . . . 154.1.1 Installation process under Windows . . . . . . . . . . . . . . . 154.1.2 Installation process under Linux . . . . . . . . . . . . . . . . . 21

4.2 Initial startup and configuration . . . . . . . . . . . . . . . . 224.2.1 Calling viomcli for the first time . . . . . . . . . . . . . . . . . 224.2.2 Validating the server configuration . . . . . . . . . . . . . . . . 244.2.3 Creating a user profile . . . . . . . . . . . . . . . . . . . . . . 25

4.3 Uninstalling VIOM CLI . . . . . . . . . . . . . . . . . . . . . 264.3.1 Uninstalling VIOM CLI under Windows . . . . . . . . . . . . . 264.3.2 Uninstalling VIOM CLI under Linux . . . . . . . . . . . . . . . 26

5 Commands and options . . . . . . . . . . . . . . . . . . . . 27

5.1 Conventions used . . . . . . . . . . . . . . . . . . . . . . . 27

5.2 Command syntax . . . . . . . . . . . . . . . . . . . . . . . . 275.2.1 Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

5.3 viomcli options . . . . . . . . . . . . . . . . . . . . . . . . . 29

5.4 Output processing command . . . . . . . . . . . . . . . . . 32

5.5 CLI objects and methods . . . . . . . . . . . . . . . . . . . 35

ServerView Virtual-IO Manager CLI

Contents

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

ivz

5.5.1 cliconfig object . . . . . . . . . . . . . . . . . . . . . . . . . . 365.5.1.1 cliconfig restore . . . . . . . . . . . . . . . . . . . . . . . . 365.5.1.2 cliconfig set . . . . . . . . . . . . . . . . . . . . . . . . . . 375.5.1.3 cliconfig show . . . . . . . . . . . . . . . . . . . . . . . . . 395.5.2 cliuser object . . . . . . . . . . . . . . . . . . . . . . . . . . . 405.5.2.1 cliuser add . . . . . . . . . . . . . . . . . . . . . . . . . . . 405.5.2.2 cliuser remove . . . . . . . . . . . . . . . . . . . . . . . . . 41

5.6 VIOM objects and methods . . . . . . . . . . . . . . . . . . . 425.6.1 api object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455.6.1.1 api get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455.6.2 config object . . . . . . . . . . . . . . . . . . . . . . . . . . . 465.6.2.1 config delete . . . . . . . . . . . . . . . . . . . . . . . . . . 465.6.2.2 config save . . . . . . . . . . . . . . . . . . . . . . . . . . 475.6.2.3 configs show . . . . . . . . . . . . . . . . . . . . . . . . . 485.6.3 iochannels object . . . . . . . . . . . . . . . . . . . . . . . . . 495.6.3.1 iochannels add . . . . . . . . . . . . . . . . . . . . . . . . 495.6.3.2 iochannel get . . . . . . . . . . . . . . . . . . . . . . . . . 615.6.3.3 iochannel remove . . . . . . . . . . . . . . . . . . . . . . . 655.6.3.4 iochannel set . . . . . . . . . . . . . . . . . . . . . . . . . 675.6.3.5 iochannels show . . . . . . . . . . . . . . . . . . . . . . . . 775.6.4 network object . . . . . . . . . . . . . . . . . . . . . . . . . . 795.6.4.1 network add . . . . . . . . . . . . . . . . . . . . . . . . . . 795.6.4.2 network get . . . . . . . . . . . . . . . . . . . . . . . . . . 805.6.4.3 network remove . . . . . . . . . . . . . . . . . . . . . . . . 815.6.4.4 network set . . . . . . . . . . . . . . . . . . . . . . . . . . 825.6.4.5 networks show . . . . . . . . . . . . . . . . . . . . . . . . 835.6.5 node object . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845.6.5.1 node getconfig . . . . . . . . . . . . . . . . . . . . . . . . . 855.6.5.2 node manage . . . . . . . . . . . . . . . . . . . . . . . . . 875.6.5.3 node restore . . . . . . . . . . . . . . . . . . . . . . . . . . 885.6.5.4 node setauth . . . . . . . . . . . . . . . . . . . . . . . . . 895.6.5.5 node setconfig . . . . . . . . . . . . . . . . . . . . . . . . . 915.6.5.6 nodes show . . . . . . . . . . . . . . . . . . . . . . . . . . 925.6.5.7 node unmanage . . . . . . . . . . . . . . . . . . . . . . . . 935.6.6 portprofile object . . . . . . . . . . . . . . . . . . . . . . . . . 945.6.6.1 portprofile get . . . . . . . . . . . . . . . . . . . . . . . . . 945.6.6.2 portprofile refresh . . . . . . . . . . . . . . . . . . . . . . . 945.6.6.3 portprofile show . . . . . . . . . . . . . . . . . . . . . . . . 955.6.7 ports object . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965.6.7.1 ports add . . . . . . . . . . . . . . . . . . . . . . . . . . . 965.6.7.2 ports remove . . . . . . . . . . . . . . . . . . . . . . . . . 98


Contents

5.6.8 power object . . . . . . . . . . . . . . . . . . . . . . . . . . . 995.6.8.1 power get . . . . . . . . . . . . . . . . . . . . . . . . . . . 995.6.8.2 power set . . . . . . . . . . . . . . . . . . . . . . . . . . . 1005.6.9 profile object . . . . . . . . . . . . . . . . . . . . . . . . . . . 1025.6.9.1 profile add . . . . . . . . . . . . . . . . . . . . . . . . . . 1025.6.9.2 profile assign . . . . . . . . . . . . . . . . . . . . . . . . . 1045.6.9.3 profiles export . . . . . . . . . . . . . . . . . . . . . . . . 1055.6.9.4 profile failover . . . . . . . . . . . . . . . . . . . . . . . . 1065.6.9.5 profile get . . . . . . . . . . . . . . . . . . . . . . . . . . . 1075.6.9.6 profiles import . . . . . . . . . . . . . . . . . . . . . . . . 1085.6.9.7 profile reassign . . . . . . . . . . . . . . . . . . . . . . . . 1095.6.9.8 profile remove . . . . . . . . . . . . . . . . . . . . . . . . 1105.6.9.9 profile set . . . . . . . . . . . . . . . . . . . . . . . . . . . 1115.6.9.10 profiles show . . . . . . . . . . . . . . . . . . . . . . . . . 1135.6.9.11 profile unassign . . . . . . . . . . . . . . . . . . . . . . . 1145.6.10 profilegroup object . . . . . . . . . . . . . . . . . . . . . . . . 1155.6.10.1 profilegroup add . . . . . . . . . . . . . . . . . . . . . . . 1155.6.10.2 profilegroup get . . . . . . . . . . . . . . . . . . . . . . . 1165.6.10.3 profilegroup remove . . . . . . . . . . . . . . . . . . . . . 1175.6.10.4 profilegroup set . . . . . . . . . . . . . . . . . . . . . . . . 1185.6.10.5 profilegroups show . . . . . . . . . . . . . . . . . . . . . . 1195.6.11 servicelan object . . . . . . . . . . . . . . . . . . . . . . . . . 1205.6.11.1 servicelan add . . . . . . . . . . . . . . . . . . . . . . . . 1205.6.11.2 servicelan get . . . . . . . . . . . . . . . . . . . . . . . . 1215.6.11.3 servicelan remove . . . . . . . . . . . . . . . . . . . . . . 1225.6.11.4 servicelan set . . . . . . . . . . . . . . . . . . . . . . . . 1235.6.12 servicevlan object . . . . . . . . . . . . . . . . . . . . . . . . 1245.6.12.1 servicevlan add . . . . . . . . . . . . . . . . . . . . . . . 1245.6.12.2 servicevlan get . . . . . . . . . . . . . . . . . . . . . . . . 1255.6.12.3 servicevlan remove . . . . . . . . . . . . . . . . . . . . . . 1265.6.12.4 servicevlan set . . . . . . . . . . . . . . . . . . . . . . . . 1275.6.13 session object . . . . . . . . . . . . . . . . . . . . . . . . . . 1285.6.13.1 session close . . . . . . . . . . . . . . . . . . . . . . . . . 1285.6.14 uplinkset object . . . . . . . . . . . . . . . . . . . . . . . . . 1295.6.14.1 uplinkset add . . . . . . . . . . . . . . . . . . . . . . . . . 1295.6.14.2 uplinkset get . . . . . . . . . . . . . . . . . . . . . . . . . 1315.6.14.3 uplinkset remove . . . . . . . . . . . . . . . . . . . . . . . 1325.6.14.4 uplinkset set . . . . . . . . . . . . . . . . . . . . . . . . . 1335.6.14.5 uplinksets show . . . . . . . . . . . . . . . . . . . . . . . 1355.6.15 vlannet object . . . . . . . . . . . . . . . . . . . . . . . . . . 1365.6.15.1 vlannet add . . . . . . . . . . . . . . . . . . . . . . . . . . 1365.6.15.2 vlannet get . . . . . . . . . . . . . . . . . . . . . . . . . . 137


Contents

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

ivz

5.6.15.3 vlannet remove . . . . . . . . . . . . . . . . . . . . . . . 1385.6.15.4 vlannet set . . . . . . . . . . . . . . . . . . . . . . . . . . 1395.6.15.5 vlannets show . . . . . . . . . . . . . . . . . . . . . . . . 140

6 Error and return codes . . . . . . . . . . . . . . . . . . . . 141

6.1 Error codes . . . . . . . . . . . . . . . . . . . . . . . . . . 1416.1.1 Major code 1000 . . . . . . . . . . . . . . . . . . . . . . . . 1426.1.2 Major code 1100 . . . . . . . . . . . . . . . . . . . . . . . . 1436.1.3 Major code 1200 . . . . . . . . . . . . . . . . . . . . . . . . 1436.1.4 Major code 1300 . . . . . . . . . . . . . . . . . . . . . . . . 1436.1.5 Major code 1400 . . . . . . . . . . . . . . . . . . . . . . . . 145

6.2 Return codes . . . . . . . . . . . . . . . . . . . . . . . . . . 146

7 Further information . . . . . . . . . . . . . . . . . . . . . . 147

7.1 Console log and log file . . . . . . . . . . . . . . . . . . . . 147

7.2 INI file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

7.3 Environment variable . . . . . . . . . . . . . . . . . . . . . 149


1 IntroductionVIOM CLI is the Command Line Interface (CLI) for VIOM, which allows you to script VIOM administration tasks. Whereas other VIOM suite products offer high-level language support and graphical administration, VIOM CLI offers a simple interface for scripting languages and automating tasks on Windows and Linux platforms.

VIOM CLI consists of two parts:

– The very small and platform-dependent viomcli binary

– The VIOM CLI server which is designed as a platform-independent JAVA service

This leads to high performance and flexibility. Client and server use sockets and a simple text-based protocol for communication, so you can even do without the platform-dependent part and use telnet or direct connection to the server instead.

The following description deals only with the command line interface. The VIOM functions are not described here. For a detailed description of VIOM, see the Virtual-IO Manager User Guide.

ServerView Virtual-IO Manager CLI 7

What‘s new

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k01

1.1 What‘s new

The current edition is valid for ServerView Virtual-IO Manager CLI as of V3.8 and replaces the online manual “ServerView Virtual-IO Manager CLI V3.7“, Edition February 2016.

This manual has been updated to reflect the latest software status.

1.2 ServerView Suite link collection

Via the ServerView Suite link collection, Fujitsu provides you with numerous downloads and further information on the ServerView Suite and PRIMERGY servers.

Under ServerView Suite, links are offered on the following topics:

● Forum

● Service Desk

● Manuals

● Product information

● Security information

● Software downloads

● Training

I Software downloads includes the following downloads:

– Current software versions for the ServerView Suite as well as additional Readme files.

– Information files and update sets for system software components (BIOS, firmware, drivers, ServerView Agents and ServerView Update Agent) for updating the PRIMERGY servers via ServerView Update Manager or for locally updating individual servers via ServerView Update Manager Express.

– The current versions of all documentation on the ServerView Suite.

You can retrieve the downloads free of charge.

8 ServerView Virtual-IO Manager CLI

Documentation for ServerView Suite

Under PRIMERGY Server, links are offered on the following topics:

● Service Desk

● Manuals

● Product information

● Spare parts catalogue

Access to the ServerView Suite link collection

You can reach the link collection of the ServerView Suite in various ways:

1. Via ServerView Operations Manager.

Ê Select Help – Links on the start page or on the menu bar.

2. Via the start page of the online documentation for the ServerView Suite on the Fujitsu manual server.

I You access the start page of the online documentation via the following link:

http://manuals.ts.fujitsu.com

Ê In the selection list on the left, select x86 Servers.

Ê On the right, click PRIMERGY ServerView Links under Selected documents.

3. Via the ServerView Suite DVD 2.

Ê In the start window of the ServerView Suite DVD 2, select the option ServerView Software Products.

Ê On the menu bar select Links.

This opens the start page of the ServerView Suite link collection.

1.3 Documentation for ServerView Suite

The documentation can be downloaded free of charge from the Internet. You will find the online documentation at http://manuals.ts.fujitsu.com under the link x86 Servers.




Documentation for ServerView Suite

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k01

ServerView Sitemap

For an overview of the documentation to be found under ServerView Suite as well as the filing structure, see the ServerView Suite Sitemap:

1. In the selection list on the left, select x86 Servers and then Software.

2. On the right, select ServerView Suite.

3. Click ServerView Suite Sitemap under Selected documents.


2 ArchitectureThe functionality of VIOM CLI is split into two applications:

Figure 1: VIOM CLI architecture

VIOM CLI client

VIOM CLI Server

Virtual I/O Management

Sockets

SOAP

ServerView DB

SOAP on HTTP/S HTTP/S

SCS

VIOM Provider

Virtual I/O Manager DB

FC AG Driver IBP Driver MMB Driver

VIOM CLI Client


Architecture

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k02

The small viomcli binary is platform-dependent and serves as an interface between the user or scripting language and the second part, the VIOM CLI server. Because of its small size and range of functions, it loads fast and is highly portable. It can also be replaced by simple telnet or any other application or script talking over sockets.

The major part of the functionality is built as a platform-independent Java service called VIOM CLI server. The server communicates with the client via sockets and with VIOM on the other side via SOAP over HTTP. Its job is to manage authentication and user profiles, to parse and validate input, to conduct SOAP communication with ServerView Connector Service (SCS), and to render response data and error messages.

The normal flow of information is as follows:

1. The user or a script calls viomcli.

2. viomcli reads settings from the user's INI file.

3. viomcli opens a socket to the VIOM CLI server and passes all command line parameters to the server.

4. The command line is parsed by the VIOM CLI server.

5. Authentication information is extracted and the user profile loaded and decrypted.

6. The SOAP message is built. Decrypted authentication information is inserted in the request.

7. The SOAP message is sent to SCS.

8. The SOAP response is received from SCS.

9. The return code is evaluated.

10.The data and return code are rendered and sent via socket to viomcli.

11.viomcli outputs the preformatted text.

12.viomcli returns the extracted return code to the operating system and exits.


3 SecuritySeveral mechanisms are implemented to secure sensitive information:

Figure 2: VIOM CLI security concept

User or Script

VIOM CLI Client

VIOM CLI Server

VIOM

Sends command

Local socket connection

Issues SOAP request

HTTPS/SSL

Encrypteduser profiles

Calls user key


Security

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k03

At command line level no sensitive information is needed. All session and authentication data is handled by the VIOM CLI server and saved in an encrypted user profile store. Each user can submit their authentication data for SCS and a self-defined key to the server for identification. For all subsequent requests, only this user key will be used. In this way scripts can use VIOM without knowing which server or access data they use.

The server part of VIOM CLI will run as a system service and accepts connections from the local host only. So the service can easily be controlled but is hard to manipulate. During requests, the server will use the given user key to identify the associated user profile and decrypt it. User profiles are stored in the user context of the server process and are thus shielded from the calling scripts.

Communication between the VIOM CLI server and VIOM is based on SOAP and can be configured to use HTTPS/SSL for security.


4 Installation and uninstallationVIOM CLI is distributed as an add-on package on the ServerView Suite DVD 2. The MSI installer packages for Windows operating systems and the RPM packages for Linux operating systems are available.

You can install VIOM CLI on the following operating systems:

– Windows– SUSE Linux– Red Hat Linux

For further information about the software requirements, refer to the Readme file, which can be found on the ServerView Suite DVD 2.

4.1 Installation process

The following two sections describe the installation process in detail for Windows and Linux operating systems.

If you have already installed a previous version of VIOM CLI on the central management station, an update installation will run automatically.

4.1.1 Installation process under Windows

Ê On Windows, log in as the administrator.

Ê Insert the ServerView Suite DVD 2 in the DVD-ROM drive. If the DVD does not start automatically, click the setup.exe file in the root directory of the DVD-ROM.

Ê Select the option ServerView Software Product Selection.

Ê Select the required language in the menu bar of the next window.

Ê Select ServerView – Virtual-IO Manager.


Installation process

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k04

Ê Double-click the file viomcli.exe to start the installation process.

Figure 3: VIOM CLI Installation Wizard - start page

The VIOM CLI Installation Wizard opens.



Ê Click Next.

Accept the license agreement by selecting the corresponding option.

Ê Click Next.

Figure 4: VIOM CLI Installation Wizard - user information

Enter your name and the name of your company/organization. You must also specify whether the settings should only apply for the current user or for any user working on this system. Select the corresponding option.



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k04

Ê Click Next.

Figure 5: VIOM CLI Installation Wizard - destination folder

Specify the destination folder for the VIOM CLI. You can change the default configuration using Browse.



Ê Click Next.

Figure 6: VIOM CLI Installation Wizard - starting the installation process

You can change the settings with Back or start the installation process with Next.



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k04

Ê Click Next.

Once the installation is complete, you will see this screen:

Figure 7: VIOM CLI Installation Wizard - successful installation

Ê Click Finish to end the installation.



4.1.2 Installation process under Linux

On Linux, open a shell as root and proceed as follows:

Ê Switch to the Linux directory on your distribution media.

Ê Start the installation with the following command:

rpm -iv viomcli-<version>.i386.rpm

For <version> specify the version and the release number of VIOM CLI (e.g. 3.7-01)

Ê Once the installation is complete, you may start the VIOM CLI server by running the following command from the shell:

/etc/init.d/viomclisrv start

I The VIOM CLI server will also be started automatically after reboot at run levels 3 and 5.


Initial startup and configuration

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k04

4.2 Initial startup and configuration

Before you start working with your newly installed VIOM CLI, you should check the configuration and make any necessary adjustments. You will find a brief overview of the main configuration tasks in this chapter. The viomcli command itself is described in the chapter "Commands and options" on page 27.

4.2.1 Calling viomcli for the first time

Open a command prompt or shell on your system and try to execute the following command:

viomcli cliconfig show

Example

You should see something similar to this:

ERROR: No INI file found, code 1server port 51000charset windows-1252language enmax. client connections 10API pool size 10console log level IMPORTANTfile log level DEBUG_EXTREMElog file C:\Documents and Settings\viom\viomclisrv.log

0 0 OK

As you are calling VIOM CLI for the first time, the error message No INI file found at the top is irrelevant; the INI file will be created automatically.

If you get this message again, it could mean that:

– Your INI file was deleted,– You do not have the relevant rights,– You do not have enough disk space to create an INI file.

The INI file will normally be created in the subdirectory viomcli in your home folder.

You may receive an error message saying that the connection to VIOM CLI server could not be established. This could be because VIOM CLI server startup is still in progress. This may take up to 30 seconds or 1 minute depending on your configuration.



On Windows

Ê Open the Services Manager window and check whether the service VIOM CLI Server is started. If not, try to start it.

On Linux

Ê Type the following command:

ps aux| grep -i viomcli

Ê If you do not find a process containing this text, try to start the VIOM CLI server by calling:

/etc/init.d/viomclisrv start

Ê If you still have problems starting the VIOM CLI server, check the rights of the user account running the service and any log files for errors. There may also be another application blocking connections to the default port (51000) of the server. You should disable this application temporarily and move on to the section "Validating the server configuration" on page 24 to change the server configuration.



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k04

4.2.2 Validating the server configuration

The command viomcli cliconfig show gives you a list of all permanent server settings.

Example

server port 51000charset windows-1252language enmax. client connections 10API pool size 10console log level IMPORTANTfile log level DEBUG_EXTREMElog file C:\Documents and Settings\viom\viomclisrv.log

Important values here are server port and charset, which you should check and adjust if necessary.

All settings can be changed using the command viomcli cliconfig set.

Example

viomcli cliconfig set --port=51000 --maxclients=5 --poolsize=3 --levelcon=not --levelfile=dbg --logfile=c:\logfile.txt --charset=UTF-8 --lang=de

The available options are described in section "cliconfig set" on page 37.

For Windows operating systems you should set the charset option to the code page of your keyboard (e.g. --charset=Windows-1252 for Western Europe). To work with national characters in cmd.exe you should also issue chcp <codepage> in your shell and select a TrueType font in the Command Prompt system menu (properties – font).

For Linux operating systems it is normally sufficient to set the charset option to UTF-8. If the charset is not being detected correctly, this may be because the LC_CTYPE variable is not set or is set incorrectly. In this case, you can set your LC_CTYPE variable (e.g. LC_CTYPE=de_DE.UTF-8) or set the right charset via the cliconfig set command.

Your chosen port number should be in the range 49152 ... 65535, but must not interfere with any service on the same machine. When you have changed the server port, you must restart the service for changes to take effect. The port value in the client INI file must also be adjusted.



4.2.3 Creating a user profile

To use viomcli with SCS and VIOM, you must specify your user account for viomcli by creating a user profile for it. To do so run the following command:

Example

viomcli --user=administrator --password=admin --key=123 --server=123.45.78.12:3172 cliuser add

This command will create a profile for the user administrator with the password admin; the destination server is 123.45.78.12 with the port 3172. The key for identification will be 123. Now you will be able to run any viomcli command as follows:

viomcli --key=123 api get

or in short

viomcli -k 123 api get

This will print a short API information summary:

Subject Version Build Java IP |- - - - - -|- - - - - -|- - -- - - - - - - - - -|- - - - - - - -|- - - - - - - - - API 3.7.0 2016-02-16 17:42:02 Manager 3.7.0 2016-02-16 17:42:07 1.8.0_66-b18 123.45.78.12 0 0 OK

The value of the --key or -k parameter is the identification key you assigned while creating the profile.


Uninstalling VIOM CLI

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k04

4.3 Uninstalling VIOM CLI

Before you uninstall VIOM CLI, you should unmanage all servers. After uninstalling VIOM CLI all information will be lost. Therefore save your server profiles if you want to use them later.

4.3.1 Uninstalling VIOM CLI under Windows

You uninstall VIOM CLI via the Windows start menu:

– On Windows Server 2008

Select Start – Control Panel – Programs and Features.

To display the product versions, select Choose Details from the View menu. Select the Version option and click OK.

– On Windows Server 2012 and newer

1. Launch the control panel.

2. In section Programs select Uninstall a program.

4.3.2 Uninstalling VIOM CLI under Linux

In order to uninstall the VIOM CLI use the rpm package manager. Execute the following command to uninstall VIOM CLI:

rpm -e ServerViewViomcli-<version>i386

For <version> specify the CLI version (e.g. 3.7-01).


5 Commands and optionsThis chapter provides an overview of all viomcli commands and options.

5.1 Conventions used

5.2 Command syntax

The general command syntax of viomcli is as follows:

Syntax

viomcli [options] [object method [parameters]]

The viomcli binary can be called with a number of options which must directly follow the executable name. These are described in section "viomcli options" on page 29.

Following the options there can be an object and an associated method. If an object is given there must also be a method. Depending on the method, there can be 0 to n parameters. Objects and methods are described in section "CLI objects and methods" on page 35 and section "VIOM objects and methods" on page 42.

semi-bold Commands, menu items, names of buttons, options, variables, file names and path names are shown in semi-bold in descriptive text.

Fixed width System outputs are shown in fixed-width type.

Fixed width semi-bold

Commands that have to be entered via the keyboard are shown in fixed-width, semi-bold type.

<abc> Angle brackets are used to indicate variables that are to be replaced by actual values.

[parameter] Square brackets are used to indicate optional parameters and options.

[<value1>[,<value2>][,...]]

Denotes a comma-separated list of variable length.

Table 1: Conventions used


Command syntax

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.2.1 Data types

The following data types are used in this document:

Type Description Usage

string String which may contain any alpha-numeric characters. A string that contains spaces must be enclosed in double quotes

-u admin--user=admin--comment="this is a comment"

integer An integer -p 1--port=1

boolean A Boolean value(TRUE / FALSE)

-bootuse means FALSE+bootuse means TRUE-d means TRUE (Short form of bootuse)The short form always means TRUE.

switch A switch. If not set it defaults to FALSE

-h--help

list A comma-separated list of properties. The property values must be given in the defined order

--s fc,dc,1,2--spec=fc,dc,1,2

Table 2: Data types


viomcli options

5.3 viomcli options

The viomcli binary can be called with a number of options which are described here.

Syntax

viomcli[ --server=<string>][ --user=<string>][ --password=<string>] --key=<string>[ --help][ --version][ --output=<string>][ --clean][ --names][ --interactive][ --telnet][ --longtext][ --system]

Parameters

These parameters are all optional except the key parameter. The key parameter is required for all VIOM object methods.

--server=<string> or short -s <string>OptionalVIOM server name or IP and port separated by a colon, for example: server:port

--user=<string> or short -u <string>OptionalUser name. A user with the Administrator role as described in the User Management in ServerView manual.

In this version the Virtual-IO Manager may only be started by a user owning the Administrator role.

--password=<string> or short -p <string>OptionalPassword

--key=<string> or short -k <string>Key to identify the user in subsequent requests

--help or short -hOptionalPrints the help

--version or short -vOptionalPrints the version information


viomcli options

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

--output=<string> or short -o <string>OptionalChanges the output mode for this method (txt, csv, xml). This parameter can be specified to switch between formatted output (txt) and program-parsable CSV or XML output. CSV and XML format can be used in nearly all list displays.

--clean or short -cOptionalIf set, no messages or errors are printed and headers and whitespace are suppressed. So output is easily processed by programs or scripts.

--names or short -nOptionalShows column names instead of labels

--interactive or short -iOptionalActivates interactive mode

--telnet or short -tOptionalActivates telnet mode

--longtext or short -lOptionalShows long-text message

--system or short -yOptionalShows system message


viomcli options

I – The -k or --key option must always be specified with any VIOM object and method to select the user profile to be used.

– For telnet mode or interactive mode it is sufficient to enter the user key only once. The same key will be used for all statements in the session.

– The -o or --output option can be specified to switch between formatted output (txt) and program-parsable CSV or XML output. CSV and XML format can be used in nearly all list displays. For output to be easily processed by programs or scripts with the --clean option, all messages, whitespace and header lines can be switched off.


Output processing command

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.4 Output processing command

The filter command can be used to search one or all columns of the result with a Java regular expression and to select one or more columns for output.

Syntax

viomcli --key=<string> filter [ --column=<integer1>[,<integer2>[,...]]][ --pattern=<string>][ --search=<integer>][ object method[parameter]]

Parameters

--key=<key> or short -k <key>Key to identify the user in the request

--column=<integer1>[,<integer2>[,...]] or short -c <integer1>[,<integer2>[,...]]OptionalA list of one or more columns to be output in the result. Multiple columns are specified as a comma-separated list of columns.

--pattern=<string> or short -p <string>OptionalRegular expression pattern

--search=<integer> or short -s <integer>OptionalColumn to search in

Example 1

viomcli.exe -k 4321 filter -c 1,2,6 -p "BLADE_S.*" -s 5 nodes show

122 BX600-4 Managed58 BX600-3 Unmanageable26 BX600S3-2 Manageable74 BX600S3-1 Unmanageable42 BX600-2 Unmanageable

0 0 OK

This example will issue the nodes show method and filters its output via the regular expression BLADE_S.* applied to column 5. Of the matching rows, only columns 1, 2 and 6 are returned.



Instead of specifying column numbers in the filter, you can use column names. For this the viomcli command must be called with the option --names or -n.

Syntax

viomcli --key=<string> --names filter [ --column=<string1>[,<string2>[,...]]][ --pattern=<string>][ --search=<integer>][ object method[parameter]]

Parameters


--names=<key> or short -n <key>OptionalShows column names instead of labels

--column=<string1>[,<string2>[,...]] or short -c <string1>[,<string2>[,...]]OptionalA list of one or more columns to be output in the result. Multiple columns are specified as a comma-separated list of columns.

--pattern=<string> or short -p <string>OptionalRegular expression pattern

--search=<integer> or short -s <integer>OptionalColumn to search in

The next example shows a filter using column names.



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

Example 2

viomcli -k 4321 -n filter -s SubType -p ".*SWITCH.*" -c Id,Name,SubType,ManageStatus nodes show

Id Name SubType ManageStatus|----|-------------------|------------|-------------86 BX600S3-1\R01 SWITCH_SLOT Manageable119 BX600S3-1\S01 LAN_SWITCH Unmanageable140 BX600-4\S02 LAN_SWITCH Managed166 BX600S3-2\S03 FC_SWITCH Manageable38 BX600S3-2\R01 SWITCH_SLOT Manageable121 BX600S3-1\S03 FC_SWITCH Unmanageable57 BX600-2\R04 SWITCH_SLOT Manageable

0 0 OK

To output only lines where a certain column is not empty, use the pattern " .+". This means there must be at least one character between the beginning and end of the column. The next example shows a filter using column names.

Example 3

viomcli -k 333 filter -s Java -p ".+" api get

Subject Version Build Java IP|--------|----------|---------------------|------------------|-------------------Manager 3.7.0 2016-02-16 17:42:07 1.8.0_66-b18 111.222.3.4

0 0 OK


CLI objects and methods

5.5 CLI objects and methods

The Command Line Interface (CLI) itself supports a small set of objects and associated methods. The following table lists the objects and associated methods of the CLI itself and the sections in which they are described.

Object Method Section

cliconfig restoresetshow

section "cliconfig restore" on page 36section "cliconfig set" on page 37section "cliconfig show" on page 39

cliuser addremove

section "cliuser add" on page 40section "cliuser remove" on page 41

Table 3: CLI objects and methods



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.5.1 cliconfig object

The cliconfig object offers methods for maintaining the CLI configuration. The cliconfig methods do not need a key for identification.

5.5.1.1 cliconfig restore

Restores the default configuration values.

Syntax

viomcli cliconfig restore

The cliconfig restore method has no parameters.

Default configuration values

The default configuration values are:

Parameter Default

server port 51 000

charset The operating system‘s default charset

language en (English)

max. client connections 10

API pool size 10

console log level NOTHING

file log level IMPORTANT

log file <userhome>/viomclisrv.log <userhome>: value of the environment variable HOMEPATH under Windows or Home under LINUX

Table 4: Default configuration values



5.5.1.2 cliconfig set

Sets configuration values.

Syntax

viomcli cliconfig set[ --port=<integer>][ --maxclients=<integer>][ --poolsize=<integer>][ --levelcon=<string>][ --levelfile=<string>][ --logfile=<string>][ --charset=string>][ --lang=<string>]

Parameters

--port=<integer> or short -p <integer>OptionalThe server port (becomes active after server restart)Possible values: 49152 - 65535Default: 51000

--maxclients=<integer> or short -m <integer>OptionalMaximum client connectionsPossible values: 1 - nDefault: 10

I Please note that a large number of connections slows down the server and uses large amounts of memory.

--poolsize=<integer> or short -s <integer>OptionalSize of object poolDefault: 10

I Please note that a large pool size increases startup time, slows down the server and uses large amounts of memory.

--levelcon=<string> or short -c <string>OptionalLog level for messages printed on the console:

notdisables output on the console (default)

sevsevere messages



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

impimportant messages

infinformational messages

dgbdebugging messages

extextended debugging messages

--levelfile=<string> or short -f <string>OptionalLog level for messages printed to log file:

notdisables output to file

sevsevere messages

impimportant messages (default)

infinformational messages

dgbdebugging messages

extextended debugging messages

--logfile=<string> or short -l <string>OptionalPath and name of log file (becomes active after server restart)Default: <userhome>/viomclisrv.log, with <userhome>: environment variable HOMEPATH under Windows or Home under LINUX

--charset=<string> or short -r <string>OptionalClient character set. All charsets of the Java platform are supported except full 16-bit charsets.Default: the operating system‘s default charset



--lang=<string> or short -g <string>OptionalLanguage:

deGerman

enEnglish (default)

jaJapanese

Example

viomcli config set --port=51000 --maxclients=5 --poolsize=3 -- levelcon=not --levelfile=dbg --logfile=c:\logfile.txt --charset=UTF-8 --lang=de

5.5.1.3 cliconfig show

Prints the CLI configuration.

Syntax


The cliconfig show method has no parameters.

Example


server port 51000charset windows-1252language enmax. client connections 10API pool size 10console log level IMPORTANTfile log level DEBUG_EXTREMElog file C:\Documents and Settings\viom\viomclisrv.log

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.5.2 cliuser object

The cliuser object offers methods for maintaining users and their user profiles.

5.5.2.1 cliuser add

Creates a user profile. The parameter values for this method are read from the viomcli options.

Syntax

viomcli --server=<server> --user=<user> --password=<password> --key=<key> cliuser add

Parameters

--server=<server> or short -s <server>VIOM server name or IP and port separated by a colon

Example

The syntax follows the general URL syntax, as follows: --server=<url>

URL of the SCS server, e.g. (IPv6 or IPv4):

– http://[::FFFF:111.222.3.4]:3172– http://111.222.3.4:3172– https://111.222.3.4:3172 (for SSL connections)

The prefix http:// may be omitted. Port 3172 may also be omitted because it is default.

--user=<user> or short -u <user>User name. A user with the AccessVIOM privilege as described in the User Management in ServerView manual.

By default users with the Administrator role have this privilege.

--password=<password> or short -p <password>Password

--key=<key> or short -k <key>Key to identify the user in subsequent requests



The key you set here will be used for identification, so you will have to specify it in any subsequent requests.

The add method has no further parameters.

Example

viomcli -s 111.222.3.4:3172 -u administrator -p admin -k mykey cliuser add

In the example, 111.222.3.4 is the central management station on which the VIOM manager is running. 3172 is the port of the ServerView Connector Service (SCS). The user administrator with the password admin will use the key mykey in any subsequent request.

5.5.2.2 cliuser remove

Deletes a user profile. The parameter values for this method are read from the viomcli options. The syntax is therefore as follows:

Syntax

viomcli --key=<key> cliuser remove

Parameters


The remove method has no further parameters.


VIOM objects and methods

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6 VIOM objects and methods

This section describes the objects and associated methods for VIOM. To use these methods you need a VIOM user account and a viomcli user profile. The following table lists the VIOM objects and associated methods and the sections in which they are described.


api get section "api get" on page 45

config deletesave

section "config delete" on page 46section "config save" on page 47

configs show section "configs show" on page 48

iochannel getremoveset

section "iochannel get" on page 61section "iochannel remove" on page 65section "iochannel set" on page 67

iochannels addshow

section "iochannels add" on page 49section "iochannels show" on page 77

network addgetremoveset

section "network add" on page 79section "network get" on page 80section "network remove" on page 81section "network set" on page 82

networks show section "networks show" on page 83

node getconfigmanagerestoresetauthsetconfigunmanage

section "node getconfig" on page 85section "node manage" on page 87section "node restore" on page 88section "node setauth" on page 89section "node setconfig" on page 91section "node unmanage" on page 93

nodes show section "nodes show" on page 92

portprofile getrefreshshow

section "portprofile get" on page 94section "portprofile refresh" on page 94section "portprofile show" on page 95

ports addremove

section "ports add" on page 96section "ports remove" on page 98

power getset

section "power get" on page 99section "power set" on page 100

Table 5: VIOM objects and methods



profile addassignfailovergetreassignremovesetunassign

section "profile add" on page 102section "profile assign" on page 104section "profile failover" on page 106section "profile get" on page 107section "profile reassign" on page 109section "profile remove" on page 110section "profile set" on page 111section "profile unassign" on page 114

profiles exportimportshow

section "profiles export" on page 105section "profiles import" on page 108section "profiles show" on page 113

profilegroup addgetremoveset

section "profilegroup add" on page 115section "profilegroup get" on page 116section "profilegroup remove" on page 117section "profilegroup set" on page 118

profilegroups show section "profilegroups show" on page 119

servicelan addgetremoveset

section "servicelan add" on page 120section "servicelan get" on page 121section "servicelan remove" on page 122section "servicelan set" on page 123

servicevlan addgetremoveset

section "servicevlan add" on page 124section "servicevlan get" on page 125section "servicevlan remove" on page 126section "servicevlan set" on page 127

session close section "session close" on page 128

uplinkset addgetremoveset

section "uplinkset add" on page 129section "uplinkset get" on page 131section "uplinkset remove" on page 132section "uplinkset set" on page 133

uplinksets show section "uplinksets show" on page 135

vlannet addgetremoveset

section "vlannet add" on page HIDDENsection "vlannet get" on page 137section "vlannet remove" on page 138section "vlannet set" on page 139

vlannets show section "vlannets show" on page 140


Table 5: VIOM objects and methods



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

Important terms in this section

Term Syntax Description

Network ID --id unique integer within the space of created networks, VLAN networks, Service LANs and Service VLANs

Network Name --name unique name within the space of networks, VLAN networks, Service LANs and Service VLANs

Table 6: Important terms



5.6.1 api object

The api object offers methods for retrieving information about the VIOM API.

5.6.1.1 api get

Prints VIOM API information.

Syntax

viomcli -k <key> api get

Parameters


The api get method has no parameters.

Example

viomcli -k 4321 api get

Subject Version Build Java IP|--------|--------|--------------------|--------------|--------API 3.7.0 2016-02-16 17:42:02Manager 3.7.0 2016-02-16 17:42:07 1.8.0_66-b18 11.1.1.1

0 0 OK

The IP address in the Manager row may be used as a trap destination in the node setauth command when managing PRIMERGY rack servers.



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.2 config object

The config object offers methods for saving the VIOM configuration.

5.6.2.1 config delete

Deletes a saved VIOM configuration file on the central management station.

Syntax

viomcli --key=<key> config delete --file=<string>

Parameters


--file=<string> or short -f <string>Name and path of the backup file

Example

viomcli -k 4321 config delete -f "backup\test.xml"

0 0 OK



5.6.2.2 config save

Saves the VIOM configuration to a file on the central management station.

Syntax

viomcli --key=<key> config save --file=<string>[ --overwrite][ --profiles][ --boottargets][ --node=<integer1>][ --node=<integer2>] ...

Parameters


--file=<string> or short -f <string>Name and, optionally, path of the backup file

--overwrite or short -oOptionalIf set, an existing backup file will be overwritten.

--profiles or short -pOptionalIf set, all server profiles will be saved.

--boottargets or short -bOptionalIf set, the defined boot targets are saved in the backup file.

--node=<integer> or short -n <integer>Node ID of a blade or PRIMERGY rack server that will be saved. The node parameter can be specified several times.

Example

viomcli -k 4321 config save -f "backup\test.xml" --overwrite -p -n 59 -n 80 -n 123

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.2.3 configs show

Shows saved VIOM configurations on the central management station.

Syntax

viomcli --key=<key> configs show

The configs show method has no parameters.

Example

viomcli -k 4321 configs show

File Created Contains Profiles Contains Boot Targets|----------------|-------------------|-----------------|--------------------backup_2807.xml 2014-07-28 08:09:10 Yes Yes test/backup.xml 2014-07-22 11:22:33 Yes Yes

Servers|------------------------------------------------BX900, QTFCQK1234567 ,BX900-2, MCH 12345, AdminSERVER, YLA0000001 ,TX300S7-9, MCH 12345, Admin



5.6.3 iochannels object

Offers methods for maintaining IO channels.

5.6.3.1 iochannels add

Adds one or more IO channels to a server profile.

Syntax

viomcli --key=<key> iochannels add --id=<integer> --spec=<list1> -|+iouse [-|+sriov] -|+bootuse[ -|+roce][ --pxeboot=<list3>][ --fcboot=<list4>][ --iscsiboot=<list5>][ --fctarget=<list6>[ --fctarget=<list6>]][ --iscsitarget=<list7>][ --vaddr=<list8>][ --name=<string>][ --taggednames=<list9>][ --svcnets=<list10>][--dcbgroup=<list11>][ --bandwidth=<integer>[,<integer2>]][ --vlanid=<integer>]

Parameters


--id=<integer> or short -i <integer>The server profile ID

The following parameters belong to a parameter group, which can be specified more than once.

--spec=<list1> or short -s <list1>IO channel specification

The IO channel must be specified by the following comma-separated list of properties:

<chantype>,<btype>,<bnum>,<port>[,<slotindex>][,<fnum>]

<chantype>Channel type (string)

lanLAN



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

fcFibre Channel

iscsiiSCSI

lanfLAN function in CNA

fcfFC function in CNA

iscsifiSCSI function in CNA

<btype>IO board type (string)

dcDaughter card

obOnboard

acExpansion card

<bnum>IO board number (integer). The system mainboard with the onboard IO channels always has the board number 1. The first daughter card (mezzanine card) has the board number 1.

<port>IO port number (integer). The first IO channel of a board has the port number 1.

<slotindex>If the server profile should cover more than one server slot this index has to specify the relative slot. The default is ru, which is also the value for a single slot or PRIMERGY rack server profile.

Valid indices are:

ruright upper slot (default)

luleft upper slot



rlright lower slot

llleft lower slot

<fnum>Function number of the iochannel in a CNA. Default value is 1.

-|+ iouse or short -u IO channel use (-iouse: no, +iouse: yes, -u: yes); defines whether an IO channel should be enabled or disabled. This allows you to enable/disable LAN ports or FC ports.

-|+ bootuse or short -d Boot device usage (-bootuse: no, +bootuse: yes, -d: yes); defines whether an IO channel is used as a boot device. Up to four IO channels can be defined as boot devices.

-|+ roce or short -o RoCE setting (-roce: no, +roce: yes, -o: yes). Defines whether RDMA over Converged Ethernet (RoCE) should be configured or not.

Default: RoCE is not set

-|+ sriov or short -r SR-IOV setting (-sriov: no, +sriov: yes, -r: yes). Defines whether Single Root I/O Virtualization (SR-IOV) should be enabled for this IO channel. Default: SR-IOV is disabled.

--bootenv=<list2> or short -e <list2>The bootenv option is outdated and is only still supported for the sake of compatibility. Instead you have the three options pxeboot, fcboot and iscsiboot.



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

--pxeboot=<list3> or short -p <list3>OptionalBoot environment for PXE boot; can only be set if the IO channel type is lan or lanf.

The PXE boot environment must be specified by the following property:

<prio>[,<ipusage>]

<prio>Boot priority (integer)

Possible values are 1, 2, 3 or 4. The boot priority 1 is the highest boot priority. This IO channel will be tried as the first boot device.

<ipusage>OptionalIP usageDefault is ip4first.Specifies the IP protocol to be used for PXE boot. You can specify the following values:

ip4firstBooting is tried first with IPv4; if this fails, IPv6 is used. (default).

ip4onlyBooting is tried only with IPv4.

ip6firstBooting is tried first with IPv6; if this fails, IPv4 is used.


--fcboot=<list4> or short -f <list4>OptionalBoot environment for SAN boot, can only be set if the IO channel type is fc or fcf. At least one fctarget must be specified.

The Fibre Channel boot environment must be specified by the following comma-separated list of properties:

<prio>,<fcspeed>,<fctop>





<fcspeed>Fibre Channel speed (integer)Specifies the transmission speed used by this port. You can specify the following values:

0auto negotiate The transmission speed is negotiated with the external switch.

11 Gbit/s full-duplex





<fctop>Fibre Channel topology (integer)Specifies the type of port connection with the external SAN network. You can specify the following values:

0auto (loop first)

4Point-to-Point

8auto (Point-to-Point first)

12Arbitrated loop



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

--iscsiboot=<list5> or short -c <list5>OptionalBoot environment for iSCSI boot; can only be set if the IO channel type is lan or iscsif.

The iSCSI boot environment must be specified by the following comma-separated list of properties:

<prio>,<initiator>[,[<address>],[<subnet>],[<gateway>][,<vlan>]]



<initiator>Name of the iSCSI initiator to be used for the connection to the iSCSI target.

<address>OptionalThe static client IP address (IPv4 address, dot-decimal notation) to be used for this port. This address is used by the port throughout the iSCSI session. If address is specified, also subnet and gateway must be specified.

<subnet>OptionalIP subnet mask (dot-decimal notation). Specifies the IP subnet mask of the network used to connect this port. If subnet is specified, also address and gateway must be specified.

<gateway>OptionalIP address of the network gateway dot-decimal notation. This specification is necessary if the iSCSI target is in a subnetwork other than the selected iSCSI boot port. If gateway is specified, also address and subnet must be specified.

I If you do not specify address, subnet and gateway, the address, subnet and gateway will be taken from the DHCP server.



--fctarget=<list6> or short -t <list6>OptionalFibre Channel target

You can define up to two Fibre Channel targets. The Fibre Channel target must be specified by the following comma-separated list of properties:

<wwpn>,<lun>

<wwpn>World Wide Port Name - WWPN (64 bits) (string)

The WWPN is specified as 16 hexadecimal characters (example: 50060e8004578604).

<lun>Logical Unit Number (integer).

The first specified target will be tried as the first target. The second target specifies the address of a second boot lun, which will be tried if the access to the first one fails. The second target is optional.

--iscsitarget=<list7> or short -g <list7>OptionaliSCSI target for the iSCSI boot.

If no iSCSI target is specified, one will be retrieved from the DHCP server via DHCP. Providing a target authentication in this case must be done in the following form:

,,,,<chapname>,<chapsecret>[,<mutualchap secret>]

An iSCSI target must be specified by the following comma-separated list of properties:

<name>,<address>,[<port>],<lun>[,<chapname>,<chapsecret>[,<mutualchapsecret>]]

<name>Name of the iSCSI target

<address>IP V4 address of the iSCSI target (dot-decimal notation)

<port>OptionalPort number of the iSCSI target



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05


<chapname>CHAP user name. If this parameter is omitted, no authentication is used. The name must be identical to the name configured on the iSCSI target.

<chapsecret>CHAP password. This password must be identical to the password configured on the iSCSI target. If specified, it must contain 12 to 16 characters.

This password must differ from the password under <mutualchap secret>.

<mutualchapsecret>Enter the mutual CHAP password in this field. This password must be identical to the password configured on the iSCSI target. If specified, it must contain 12 to 16 characters.

This password must differ from the password under <chapsecret>.

--vaddr=<list8> or short -v <list8>OptionalVirtual address to be defined for this IO channel.

If you have selected an address range for the virtual MAC and/or WWN addresses during VIOM installation, by default the virtual address must be within the specified range.

If you have not specified an address range during installation or you enclose the address in parentheses, no range checking will be performed by VIOM.

If you do not specify this parameter, the virtual address is automatically generated from the range configured.

Specify the WWN addresses (World WideNode Name and World Wide Port Name) and/or the MAC address in the following order:

[<mac>]|[<wwnn>],[<wwpn>][,<mac>]

<mac> in case of channel type lan, lanf, iscsi, iscsif



<mac>MAC address

The MAC address is specified as 12 hexadecimal characters.

<wwnn>World Wide Node Name - WWNN

The WWNN is specified as 16 hexadecimal characters.


The WWPN is specified as 16 hexadecimal characters.

I If you do not enter an address, it is automatically generated from the predefined range.

--name=<string> or short -n <string>OptionalNetwork name

I Different functions of the same CNA port share the same network.

--taggednames=<list9> or short -a <list9>OptionalComma-separated list of tagged VLAN names

--svcnets=<list10> or short -m <list10>OptionalComma-separated list of service LAN or service VLAN names

--dcbgroup=<list11> or short -w <list11>OptionalComma-separated list of DCB parameters.

[<weight>][,<priority level>]

<weight>Bandwidth reservation in per cent (integer)

Possible values between 0 and 100.

<wwnn>,<wwpn> in case of channel type fc

<wwnn>,<wwpn>,<mac> in case of channel type fcf



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

The weight needs only be specified if the bandwidth parameter is missing.

<priority level >Priority level of the priority group (integer)

Possible values between 0 and 7. Defaults are 3 for fibre channel respectively 4 for iSCSI.

--vlanid=<integer> or short -l <integer>OptionalVLAN ID of the IO channel.

--bandwidth=<integer>[,<integer2>] or short -h <integer>[,<integer2>]OptionalThe bandwidth option allows you to specify one or two values between 1 and 100 and may only be specified for CNA functions. If specified, it will override the weight in the dbcgroup parameter.

The first integer (<integer>) represents the minimal bandwidth. The sum of all minimal bandwidths of the IO channels on same CNA port should be 100. Otherwise, these minimal bandwidth values will be adapted to reach a sum of 100.

If a second value (<integer2>) is specified, this value represents the maximal bandwidth. It must not be less than the minimal bandwidth. If omitted, a value of 100 is assumed.

I – The group parameters define an IO channel. They must be used together whereby the group must always start with the parameter spec. You can use one or more parameter groups for IO channels.

– If iouse is set to No, you cannot specify bootuse, pxeboot, fcboot, iscsiboot, fctarget, iscsitarget or vaddr.

– If bootuse is set to Yes, you must specify pxeboot or fcboot or iscsiboot.

– If bootuse is set to Yes and chantype to fc or fcf, you must specify fcboot and at least one fctarget.

– If bootuse is set to Yes and chantype to lan, you must specify pxeboot or iscsiboot.



Example 1

To configure an iSCSI boot for an IO channel with the initiator name Initiator and VLAN ID 11, and to configure a DHCP for the source and target systems, use the following command:

viomcli -k 4321 iochannels add -id=2 --spec=lan,ob,1,1 +iouse +bootuse --iscsiboot=1.initiator,,,,11 --name=Network_2

0 0 OK

Example 2

viomcli -k 4321 iochannels add -id=2 --spec=lan,ob,1,1 +iouse +bootuse --iscsiboot=1,name,,,,12 --iscsitarget=,,,,chapname,secretsecret

0 0 OK

In this example, DHCP is used for the target system and CHAP is used as the authentication method.

Example 3 virtual addressing

In the following example it is assumed that the following address ranges were defined during installation:

– For MAC addresses the range: 00:19:99:3E:D2:A1 - 00:19:99:3E:F1:E0– For WWN addresses the range:

50:01:99:93:ED:2A:10:00 - 50:01:99:93:EF:1E:0D:FF

In the following, we will define a server profile with the name Profile_1 and four IO channels (one LAN channel and three FC channels):

viomcli -k 1234 profile add --name=Profile_1 +virt +boot10 0 OK

In this example, the returned server profile ID is 1.



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

Defining the IO channels:

viomcli -k 1234 iochannels add --id=1 --spec=lan,ob,1,1 +iouse +bootuse --pxeboot=1 --vaddr=0019993ef000 --name=Network_10 0 OK

viomcli -k 1234 iochannels add --id=1 --spec=fc,dc,1,1 +iouse +bootuse --fcboot=2,10,2 --vaddr=50019993EF000000 --fctarget=00aabbccddeeff00,1 --name=Network_20 0 OK

viomcli -k 1234 iochannels add --id=1 --spec=fc,dc,1,2 +iouse +bootuse --fcboot=3,10,2 --vaddr=,50019993EF000001 --fctarget=00aabbccddeeff00,1 --name=Network_20 0 OK

viomcli -k 1234 iochannels add --id=1 --spec=fc,dc,1,3 +iouse +bootuse --fcboot=4,10,2 --vaddr=50019993EF000002, 50019993EF000003 --fctarget=00aabbccddeeff00,1 --name=Network_20 0 OK

Example 4

Compare this example with example 1. This time the MAC address 01:01:01:01:01:01 is not within the range specified during installation and therefore it must be enclosed in parentheses.

viomcli -k 1234 iochannels add --id=1 --spec=lan,ob,1,1 +iouse +bootuse --pxeboot=1 --vaddr=(010101010101) --name=Network_1

0 0 OK



5.6.3.2 iochannel get

Gets information about an IO channel.

Syntax

viomcli --key=<key> iochannel get --id=<integer> --spec=<list>[ --boot| --address| --dcbgroups]

Parameters



--spec=<list> or short -s <list>IO channel specification




lanLAN

fcFibre Channel

iscsiiSCSI






© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05


dcDaughter card

obOnboard

acExpansion card



<slotindex>If the server profile should cover more than one server slot this index has to specify the relative slot. The default is ru, which is also the value for a single slot profile.

Valid indices are:


luleft upper slot

rlright lower slot

llleft lower slot


--boot or short -bOptionalShows boot environment only



--address or short -aOptionalShows address virtualization only

--dcbgroups or short -wOptionalShows the priority group associated with the IO channel.

Example 1

viomcli -k 4321 iochannel get -i 123 --spec=fc,dc,1,2

Server. Profile Id: 123Network name: net2IO channel usage: YesBoot device usage: YesService network name: svcnet1Service network name: svcnet2Tagged VLAN name: name100 0 OK

Example 2

viomcli -k 4321 iochannel get --id=3 --spec=fcf,dc,1,1,ru,2 -bBoot Prio. Link Speed FC Topo. WWPN LUN|-----------|-----------|---------|------------------------|----1 0 8 01:01:01:01:01:01:01:01 01 0 8 02:02:02:02:02:02:02:02 0

0 0 OK

Example 3

In this example the iochannel is used for Fibre Channel over Ethernet

viomcli -k 4321 iochannel get --id=3 --spec=fcf,dc,1,1,ru,2 --dcbgroupsPriority Level Weight Purpose|---------------|-------|--------3 50 FCoE

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

Example 4

In this example, query the boot parameters for the iSCSI boot (as configured in example 2 on page 59).

viomcli -k 4321 iochannel get -i 2 --spec=lan,ob,1,1 --boot

DHCP Initiator Address Netmask Gateway VLAN ID DHCP Target Address Port LUN CHAP |----|---------|-------|-------|-------|----|---|----|------|-------|----|---|-----Yes name 12 Yes CHAP

Name Secret Mutual Secret|---------|-------------|-------------chapname secretsecret

0 0 OK

Example 5

In this example, query which virtual addresses in example 3 on page 59 are currently assigned for each IO channel:

viomcli -k 1234 iochannel get --id=1 --spec=lan,ob,1,1 -a

MAC WWNN WWPN|-----------------|-------------------------|-----------------------00:19:99:3e:f0:00 0 0 OK

viomcli -k 1234 iochannel get --id=1 --spec=fc,dc,1,1 -a

MAC WWNN WWPN|-----------------|-------------------------|----------------------- 50:01:99:93:ef:00:00:00 50:01:99:93:ed:2a:10:000 0 OK


MAC WWNN WWPN|-----------------|-------------------------|----------------------- 50:01:99:93:ed:2a:10:01 50:01:99:93:ef:00:00:010 0 OK


MAC WWNN WWPN|-----------------|-------------------------|----------------------- 50:01:99:93:ef:00:00:02 50:01:99:93:ef:00:00:030 0 OK



5.6.3.3 iochannel remove

Remove an IO channel.

Syntax

viomcli --key=<key> iochannel remove --id=<integer> --spec=<list>

Parameters







lanLAN

fcFibre Channel

iscsiiSCSI






© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05


dcDaughter card

obOnboard

acExpansion card



<slotindex>If the server profile should cover more than one server slot this index has to specify the relative slot. The default is ru, which is also the value for a single slot profile.

Valid indices are:


luleft upper slot

rlright lower slot

llleft lower slot




5.6.3.4 iochannel set

Sets values of an existing IO channel.

Syntax

viomcli --key=<key> iochannel set --id=<integer> --spec=<list1> -|+iouse [-|+sriov] -|+bootuse[ -|+roce][ -|+dcbuse][ --pxeboot=<list3>][ --fcboot=<list4>][ --iscsiboot=<list5>][ --fctarget=<list6>[ --fctarget=<list6>]][ --iscsitarget=<list7>][ --vaddr=<list8>][ --name=<string>][ --taggednames=<list9>][ --svcnets=<list10>][ --dcbgroup=<list11>][ --bandwidth=<integer>][,<integer2>][ --vlanid=<integer>]

Parameters



The following parameters belong to a parameter group, which can be specified more than once.





lanLAN

fcFibre Channel

iscsiiSCSI



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05





dcDaughter card

obOnboard

acExpansion card



<slotindex>If the server profile should cover more than one server slot this

index has to specify the relative slot. The default is ru, which is

also the value for a single slot profile.

Valid indices are:


luleft upper slot

rlright lower slot



llleft lower slot


-|+ iouse or short -u IO channel use (-iouse: no, +iouse: yes, -u: yes); defines whether an IO channel should be enabled or disabled. This allows you to enable/disable LAN ports or FC ports.

-|+ sriov or short -r OptionalSR-IOV setting (-sriov: no, +sriov: yes, -r: yes).

Defines whether Single Root I/O Virtualization (SR-IOV) should be enabled for this IO channel.

-|+ bootuse or short -d Boot device usage (-bootuse: no, +bootuse: yes, -d: yes); defines whether an IO channel is used as a boot device. Up to four IO channels can be defined as boot devices.

-|+ roce or short -o RoCE setting (-roce: no, +roce: yes, -o: yes). Defines whether RDMA over Converged Ethernet (RoCE) should be configured or not.

Default: RoCE setting is not changed

-|+ dcbuse or short -b OptionalEnables or disables Data Center Bridging of the iochannel (-dcbuse: disabled, +dcbuse: enabled, -b: enabled)

I -dcbuse will delete a priority group.

--bootenv=<list2> or short -e <list2>The bootenv option is outdated and is only still supported for the sake of compatibility. Instead you have the three options pxeboot, fcboot and iscsiboot.

--pxeboot=<list3> or short -p <list3>OptionalBoot environment

The PXE boot environment must be specified by the following property:



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

<prio>[,<ipusage>]



<ipusage>OptionalIP usageSpecifies the IP protocol to be used for PXE boot. You can specify the following values:





Default: IP usage is not changed

--fcboot=<list4> or short -f <list4>OptionalBoot environment, can only be set if the IO channel type is fc or fcf.

The Fibre Channel boot environment must be specified by the following comma-separated list of properties:

<prio>,<fcspeed>,<fctop>



<fcspeed>Fibre Channel speed (integer)Specifies the transmission speed used by this port. You can specify the following values:



0auto negotiate The transmission speed is negotiated with the external switch.






<fctop>Fibre Channel topologySpecifies the type of port connection with the external SAN network. You can specify the following values:

0auto (loop first)

4Point-to-Point

8auto (Point-to-Point first)

12Arbitrated loop

--iscsiboot=<list5> or short -c <list5>OptionalBoot environment for iSCSI boot; can only be set if the IO channel type is lan or iscsif.

The iSCSI boot environment must be specified by the following comma-separated list of properties:

<prio>,<initiator>[,[<address>],[<subnet>],[<gateway>][,<vlan>]]



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05



<initiator>Name of the iSCSI initiator to be used (in the case of an iSCSI boot) for the connection to the iSCSI target.

<address>OptionalThe static client IP address (IPv4 address, dot-decimal notation) to be used for this port. This address is used by the port throughout the iSCSI session. If address is specified, also subnet and gateway must be specified.

<subnet>OptionalIP subnet mask (dot-decimal notation). Specifies the IP subnet mask of the network used to connect this port (in the case of an iSCSI boot). If subnet is specified, also address and gateway must be specified.



<gateway>OptionalIP address of the network gateway (dot-decimal notation). This specification is necessary if the iSCSI target is in a subnetwork other than the selected iSCSI boot port. If gateway is specified, also address and subnet must be specified.

I If you do not specify address, subnet and gateway, the address, subnet and gateway will be taken from the DHCP server.

--fctarget=<list6> or short -t <list6>OptionalFibre Channel target

You can define up to two Fibre Channel targets. The Fibre Channel target must be specified by the following comma-separated list of properties:

<wwpn>,<lun>



--iscsitarget=<list7> or short -g <list7>OptionaliSCSI target for the iSCSI boot.

If no iSCSI target is specified, one will be retrieved from the DHCP server via DHCP. Providing a target authentication in this case must be done in the following form:

,,,,<chapname>,<chapsecret>[,<mutualchap secret>]

An iSCSI target must be specified by the following comma-separated list of properties:

<name>,<address>,[<port>],<lun>[,<chapname>,<chapsecret>[,<mutualchap secret>]]

<name>Name of the iSCSI target

<address>IP V4 address of the iSCSI target (dot-decimal notation)



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

<port>OptionalPort number of the iSCSI target


<chapname>CHAP user name. If this parameter is omitted, no authentication is used. The name must be identical to the name configured on the iSCSI target.

<chapsecret>CHAP password. This password must be identical to the password configured on the iSCSI target. If specified, it must contain 12 to 16 characters.

This password must differ from the password under <mutualchap secret>.

<mutualchap secret>Enter the mutual CHAP password in this field. This password must be identical to the password configured on the iSCSI target. If specified, it must contain 12 to 16 characters.

This password must differ from the password under <chapsecret>.

--vaddr=<list8> or short -v <list8>OptionalVirtual address to be defined for this IO channel.

If you have selected an address range for the virtual MAC and/or WWN addresses during VIOM installation, by default the virtual address must be within the specified range.

If you have not specified an address range during installation or you enclose the address in parentheses, no range checking will be performed by VIOM.

If you do not specify this parameter, the virtual address is automatically generated from the range configured.

Specify the WWN addresses (World WideNode Name and World Wide Port Name) and/or the MAC address in the following order:

[<mac>]|[<wwnn>],[<wwpn>][,<mac>]



<mac>MAC address

The MAC address is specified as 12 hexadecimal characters.

<wwnn>World Wide Node Name - WWNN

The WWNN is specified as 16 hexadecimal characters.


The WWPN is specified as 16 hexadecimal characters.

I If you do not enter an address it is automatically generated from the predefined range.

<mac> in case of channel type lan, lanf, iscsi, iscsif

<wwnn>,<wwpn> in case of channel type fc

<wwnn>,<wwpn>,<mac> in case of channel type fcf



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

--name=<string> or short -n <string>OptionalNetwork name

I Different functions within the same CNA port share the same network. Therefore a previous network may be overwritten.

--taggednames=<list9> or short -a <list9>OptionalComma-separated list of tagged VLAN names

--svcnets=<list10> or short -m <list10>OptionalComma-separated list of service LAN or service VLAN names

--dcbgroup=<list11> or short -w <list11>OptionalComma-separated list of DCB parameters. If a priority group is specified, +dcbuse must be specified as well.

[<weight>],[<priority level>]



The weight needs only be specified if the bandwidth parameter is missing.

<prioritylevel >Priority level of the priority group (integer)

Possible values between 0 and 7. Defaults are 3 for fibre channel respectively 4 for iSCSI.

--vlanid=<integer> or short -l <integer>OptionalVLAN ID of the IO channel.

--bandwidth=<integer>[,<integer2>] or short -h <integer>[,<integer2>]OptionalThe bandwidth option allows you to specify one or two values between 1 and 100 and may only be specified for CNA functions. If specified, it will override the weight in the dbcgroup parameter.



The first integer (<integer>) represents the minimal bandwidth. The sum of all minimal bandwidths of the IO channels on same CNA port should be 100. Otherwise, these minimal bandwidth values will be adapted to reach a sum of 100.

If a second value (<integer2>) is specified, this value represents the maximal bandwidth. It must not be less than the minimal bandwidth. If omitted, a value of 100 is assumed.

I – If iouse is set to No, you cannot specify bootuse, pxeboot, fcboot, iscsiboot, fctarget, iscsitarget or vaddr.

– If bootuse is set to Yes, you must specify pxeboot or fcboot or iscsiboot.

– If bootuse is set to Yes and chantype to fc or fcf, you must specify fcboot and at least one fctarget.

– If bootuse is set to Yes and chantype to lan, you must specify pxeboot or iscsiboot only.

Example

viomcli -k 4321 -o csv iochannel set -i 2 --spec=fc,dc,1,2 +iouse -bootuse -n net3

0 0 OK

5.6.3.5 iochannels show

Shows IO channels of a server profile.

Syntax

viomcli --key=<key> iochannels show --id=<integer>

Parameters





© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

Example

viomcli -k 123 iochannels show --id=2

Ch. Type Index Brd. Type Brd. Number Port Number Function Number Netw. Name|---------|------|----------|------------|------------|----------------|-----------LAN OnBoard 1 1 1 Net_2 LAN OnBoard 1 2 1 LAN rl OnBoard 1 1 1 Net_2 LAN rl OnBoard 1 2 1

NIO Ch. usage Boot Usage Boot Prio. FC Boot Cfg. DCB SRIOV usage RoCE usage |-------------|-----------|-----------|-------------|----|------------|-----------Yes Yes 1 No No No Yes No No No No Yes Yes 2 No No No Yes No No No No

0 0 OK

This command output shows the IO channels of a server profile for a BX960 CPU blade with double height. The Index column is only used for multi slot CPU blades and is the slot index described in the iochannels add command.



5.6.4 network object

Offers methods for maintaining a VIOM network.

5.6.4.1 network add

Creates a new a network. The command returns the network ID of the newly created network to standard output.

Syntax

viomcli --key=<key> network add --name=<string>--node=<integer>[ --uset=<integer>][ +|-isol][ --comment=<string>]

Parameters


--name=<string> or short -n <string>The network name

--node=<integer> or short -o <integer>The node ID of a switch slot. To allow networks to be added, an IBP connection blade must be plugged into this switch slot.

In the case of switch stacking the node ID of the master switch slot has to be specified here. For more information about switch stacking, see the Virtual-IO Manager User Guide.

--uset=<integer> or short -u <integer> OptionalAn uplink set ID. If omitted, an internal network will be created.

+|-isol or short -j OptionalDownlink isolation for the network (-isol: no, +isol: yes, -j: yes). The default is no downlink isolation.

--comment=<string> or short -c <string>OptionalA comment



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

Example

viomcli -k 4321 network add -n test_net -o 134

50 0 OK

In this example, 5 is the ID of the newly created network, which is written to standard output. The command status information (0 0 OK) is written to standard error. If an error happens (return code not 0), no ID is written to standard output.

5.6.4.2 network get

Gets information about a network.

Syntax

viomcli --key=<key> network get --id=<integer>[ --comment]

Parameters


--id=<integer> or short -i <integer>The network ID

--comment or short -cOptionalShows comment only

Example

viomcli -k 4321 network get -i 14

Netw. Name Netw. Id Node Id Uplink Set Id Slots Isolation|-----------|---------|--------|--------------|-----|--------test_net_2 14 134 null No

0 0 OK



5.6.4.3 network remove

Removes a network.

Syntax

viomcli --key=<key> network remove --id=<integer>

Parameters



Example

viomcli -k 4321 network remove -i 14

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.4.4 network set

Sets values of an existing network.

Syntax

viomcli --key=<key> network set --id=<integer>[ --name=<string>][ --uset=<integer>][ +|-isol][ --comment=<string>]

Parameters



--name=<string> or short -n <string>OptionalThe network name

--uset=<integer> or short -u <integer> OptionalAn uplink set ID

+|-isol or short -j OptionalDownlink isolation for the network (-isol: no, +isol: yes, -j: yes).


Example

viomcli -k 4321 network set -i 14 -n test_net2 -c "my test network II"

0 0 OK



5.6.4.5 networks show

Shows networks of a node.

Syntax

viomcli --key=<key> networks show --node=<integer>

Parameters


--node=<integer> or short -o <integer>The node ID of a switch slot

Example

viomcli -k 4321 networks show -o 134

Networks: ===========

Netw. Name Netw. Id Node Id Uplink Set Id Slots |-----------|---------|--------|--------------|------NET_1 5 134 5 []NET_2 6 134 6 []NET_3 7 134 7 []NET_4 8 134 8 []test_net 13 134 null []test_net_2 14 134 null []

VLAN Networks: ================

Netw. Name Netw. Id Node Id Uplink Set Id Slots VLAN Id |-----------|---------|--------|--------------|------|--------

Service LANs: ===============

Netw. Name Netw. Id Node Id Uplink Set Id Slots VLAN Id|-----------|---------|--------|--------------|------|--------

Service VLANs: ================

Netw. Name Netw. Id Node Id Uplink Set Id Slots VLAN Id |-----------|---------|--------|--------------|------|--------

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.5 node object

Offers methods for maintaining a VIOM node.

A node is any type of device and is uniquely identified by its node ID. A node has a main type (such as Group or Slot) and a subtype (such as Blade_Server or Server_Slot).

The following node types are possible:

A node can have associations to other nodes. A node object of type Group, for example, has the association "provider" to its targets, e.g. the slots.

Main type Subtype

Slot Server_Slot

Slot Switch_Slot

Switch LAN_Switch

Switch FC_Switch

Switch Switch

Group Blade_Server

MMB MMB

Server Server

Server Blade

Table 7: Node types



5.6.5.1 node getconfig

Shows configuration information about a node.

Syntax

viomcli --key=<key> node getconfig --node=<integer>[ --assoc]

Parameters


--node=<integer> or short -n <integer>The node ID to be shown

--assoc or short -aOptionalShow associations only

Example 1

viomcli -k 4321 node getconfig -n 135 -a

Node Id Type Direction

|---------|-------|----------122 Group Provider140 Slot Target0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

Example 2

viomcli -k 4321 node getconfig -n 122

node Id: 122node type: GROUP BLADE_SERVERnode name: BX600-4node status: OKSerial Number: sqywwn00000VIOM manage status: ManageableVIOM fault status: OkVIOM fault causes:system: BX600-4UUID:product: PRIMERGY BX600 Management Blade S3firmware: 3.08housing: BX600S3admin IP: 111.22.33.44administrator: Martin Musterlocation: MCH 12345firmware: 3.08admin firmware: 2.09housing: BX600S3IP: 111.22.33.43admin IP: 111.22.33.44

Associations:===============

Node Id Type Direction|--------|------|----------131 Group Target107 Group Target136 Group Target126 Group Target139 Group Target127 Group Target123 Group Target130 Group Target135 Group Target140 Group Target128 Group Target134 Group Target129 Group Target124 Group Target137 Group Target132 Group Target133 Group Target106 Group Target125 Group Target138 Group Target

0 0 OK



5.6.5.2 node manage

Manages a node. It is only possible to manage nodes of type Group Blade_Server or Server Server which are manageable.

Syntax

viomcli --key=<key> node manage --node=<integer>[ --nopath][ --force]

Parameters


--node=<integer> or short -n <integer>The node ID (blade server or PRIMERGY rack server) to manage

--nopath or short -p If set: When managing a blade server chassis, VIOM handles all connection blades transparently and does not support configuration of network paths.

--force or short -fOptionalForce it, even if the node is managed by another Virtual-IO Manager. If a node is specified which is already managed by another management station, the request to manage this server will fail with a corresponding error. The force parameter allows this node to be managed, even in this case. The force parameter should not be used by default. You should only use it if you are sure that the other management station is no longer used.

Example

viomcli -k 4321 node manage -n 17 -f

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.5.3 node restore

Restores a node to reflect VIOM‘s internal configuration.

Syntax

viomcli --key=<key> node restore --node=<integer>

Parameters


--node=<integer> or short -n <integer>The node ID (blade server, switch slot, server slot, PRIMERGY rack server) to be restored

Example

viomcli -k 4321 node restore -n 140

0 0 OK



5.6.5.4 node setauth

Sets authentication information for a node.

Syntax

viomcli --key=<key> node setauth --node=<integer> --prot=<string> --user=<string> --pass=<string> --port=<integer>[ --trap=<string>]

Parameters


--node=<integer> or short -n <integer>The node ID of the node for which authentication data is to be set. This is possible for MMB, switch and PRIMERGY rack server nodes. Currently it is necessary to set the authentication data for the MMB of a blade server and for IBP connection blades for the blade server chassis to be managed by VIOM as well as for PRIMERGY rack server s that are going to be managed.

--prot=<string> or short -r <string>The protocol:

teltelnet

sshSecure Shell

ipmiIPMI over LAN

--user=<string> or short -u <string>The user name

--pass=<string> or short -w <string>The user‘s password



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

--port=<integer> or short -p <integer>The protocol port

--trap=<string> or short -t <string>OptionalIP address to be used by a managed PRIMERGY rack server to send SNMP traps. See section "api get" on page 45.

I – For a node of type SWITCH, the protocol must be telnet with port 23 by default or SSH with port 22 by default.

– For a node of type MMB, the protocol must be telnet with port 3172 by default or SSH with port 22 by default.

– For a PRIMERGY rack server node, the type must be IPMI over LAN with port 623 by default.

Example

viomcli -k 4321 node setauth -n 17 --prot=tel -u test --pass=test1 --port=3172

0 0 OK



5.6.5.5 node setconfig

Sets values of an existing node.

Syntax

viomcli --key=<key> node setconfig --id=<integer>[ --spare]

Parameters


--id=<integer> or short -i <integer>The node ID

--spare or short -sOptionalIf set, this node becomes a spare node for failover (for a server slot only).

I If spare is not set, an existing spare configuration will be deleted.

Example

viomcli -k 4321 node setconfig -i 17 -spare

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.5.6 nodes show

Shows all nodes.

Syntax

viomcli --key=<key> nodes show

Parameters


The nodes show method has no parameters.

Example

viomcli -k 4321 nodes show

Change 1

Id Node Name State Main Type Sub Type VIOM State Assoc. Type

|----|------------------|----------|-----------|-------------|-----------|---------------------

62 BX600-3\F03 Unknown SLOT SERVER_SLOT Group, Provider, 58

Slot, Target, 105

30 BX600S3-2\F03 Unknown SLOT SERVER_SLOT Group, Provider, 26

Slot, Target, 92

31 BX600S3-2\F04 Unknown SLOT SERVER_SLOT Group, Provider, 26

Slot, Target, 93

95 TX300-RD OK SERVER SERVER

123 BX600-4\M00 OK MMB MMB Group, Provider, 122

113 BX600S3-1\C03 Unknown SERVER BLADE Group, Provider, 74

Slot, Provider, 78

86 BX600S3-1\R01 Unknown SLOT SWITCH_SLOT Group, Provider, 74



5.6.5.7 node unmanage

Sets a node to unmanaged.

Syntax

viomcli --key=<key> node unmanage --node=<integer>

Parameters


--node=<integer> or short -n <integer>The node ID to be set to unmanaged

Example

viomcli -k 4321 node unmanage -n 17

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.6 portprofile object

Offers methods for getting information on existing portprofile and for refreshing the list of existing portprofiles.

5.6.6.1 portprofile get

Provides information on an existing portprofile.

Syntax

viomcli --key=<key> portprofile get --id=<integer>

Parameters


--id=<integer> or short -I <integer>The id of an existing portprofile as returned as part of the result of the portprofiles show method

5.6.6.2 portprofile refresh

Reads the list of existing portprofiles for the specified node and updates (refreshes) the stored list in VIOM by adding the new information. The specified node must contain a connection blade that supports portprofiles.

Syntax

viomcli --key=<key> portprofile refresh --node=<integer>

Parameters


--node=<integer> or short -n <integer>The node ID of a switch slot. It must contain a connection blade that supports portprofiles.



5.6.6.3 portprofile show

If the specified connection blade supports portprofiles: Lists the existing portprofiles for the this connection blade.

Syntax

viomcli --key=<key> portprofile show --node=<integer>

Parameters


--node=<integer> or short -n <integer>The node ID of a switch slot. It must contain a connection blade that supports portprofiles.



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.7 ports object

Offers methods for maintaining a VIOM uplink port.

5.6.7.1 ports add

Adds one or more uplink ports to an uplink set.

Syntax

viomcli --key=<key> ports add --uid=<integer> --port=<list>[ --port=<list>] ...

Parameters


--uid=<integer> or short -u <integer>The uplink set ID

The following parameter can be specified more than once.

--port=<list> or short -p <list>The uplink port to be added. The port must be specified by the following comma-separated list of properties:

<portnumber>,<backup>[,<slotid>]

<portnumber>the uplink port number

Uplink port numbers always start by 1 independently of the IBP. Thus, for example, --port=1,N could mean port 0/11 on an IBP10/6 or 0/31 on an IBP30/12.



<backup>serves as backup (boolean):

YYes

NNo

<slotid>In case of switch stacking, this is the slot ID of the port to add. Default is the node ID of the master switch slot.

Example

viomcli -k 4321 ports add --uid=1 --port=2,Y --port=3,N

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.7.2 ports remove

Removes one or more ports from an uplink set.

Syntax

viomcli --key=<key> ports remove --uid=<integer> --port=<list>[ --port=<list>] ...

Parameter


--uid=<integer> or short -u <integer>The uplink set ID

The following parameter can be specified more than once.

--port=<list> or short -p <list>The uplink port to be removed. The port must be specified by the following comma-separated list of properties:

<portnumber>[,<slotid>]

<portnumber>The uplink port number (integer)

Uplink port numbers always start by 1 independently of the IBP. Thus, for example, port 1 could mean port 0/11 on an IBP10/6 or 0/31 on an IBP30/12.

<slotid>In case of switch stacking, this is the slot ID of the port to remove. Default is the slot ID with the stack master.

Example

viomcli -k 4321 ports remove --uid=10 -p 2 --port=3

0 0 OK



5.6.8 power object

Offers methods for power management.

5.6.8.1 power get

Shows power information for a node.

Syntax

viomcli --key=<key> power get --node=<integer>

Parameters


--node=<integer> or short -n <integer>The node ID (server blade, PRIMERGY rack server) for which to show power information

Example

viomcli -k 4321 power get -n 138

Node Id Power Mode Boot Mode Status|--------|-----------|----------|----------------138 Off Normal PowerOnPending

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.8.2 power set

Sets values for power configuration.

Syntax

viomcli --key=<key> power set --node=<integer> --power=<string> --boot=<string>

Parameters


--node=<integer> or short -n <integer>The node ID (server blade, PRIMERGY rack server) for which to set power configuration

--power=<string> or short -p <string>Power mode:

onswitch on

gsperform graceful shutdown

pcpower cycle

rstreset

foforce off

--boot=<string> or short -b <string>Boot mode

normnormal

pxe1PXE LAN 1

pxe2PXE LAN 2



pxe3PXE LAN 3

pxe4PXE LAN 4

pxe5PXE LAN 5

pxe6PXE LAN 6

pxe7PXE LAN 7

pxe8PXE LAN 8

pci1PCI 1

pci2PCI 2

invinventory

initinit

Example

viomcli -k 4321 power set -n 138 -p pc -b pxe1

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.9 profile object

Methods for maintaining server profiles

5.6.9.1 profile add

Creates a new server profile. The command returns the ID of the newly created server profile to standard output.

Syntax

viomcli --key=<key> profile add --name=<string> -|+virt -|+boot[ --smux=<string>][ --comment=<string>][ --parent=<id>][ --uefi=<string>]

Parameters


--name=<string> or short -n <string>Server profile name

-|+virt or short -v IO virtualization usage (-virt: no, +virt: yes, -v: yes)

-|+boot or short -b Boot menu usage (-boot: no, +boot: yes, -b: yes)

--smux=<string> or short -s <string>OptionalConnecting mezzanine cards to switch fabrics. Here, you specify the fabric to which the LAN daughter card is routed.

fabric3 All paths are routed to fabric 3.

fabric4StandardAll paths are routed to fabric 4.

fabric34LAN1 is routed to fabric 3 and LAN2 to fabric 4.




--parent=<id> or short -p <id>OptionalThe ID of the profile group that should be the parent of this profile. Default is the root profile group.

--uefi=<string> or short -u <string>OptionalDefines the boot interface for IO channels that are configured for booting.

legacyfirst Standard Legacy boot is tried first.

uefionly UEFI boot

uefifirst UEFI boot is tried first.

legacyonlyLegacy boot

Example 1

viomcli -k 4321 profile add -n test3 -v +boot -c "my comment"

170 0 OK

In this example 17 is the ID of the newly created server profile, which is written to standard output. The command status information (0 0 OK) is written to standard error. If an error happens (return code not 0), no ID is written to standard output.

Example 2

viomcli -k 1234 profile add -n Profile1 -v -s fabric3 -c "my comment"

80 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

In this example, a server profile in which both mezzanine cards are connected to fabric 3 is created.

5.6.9.2 profile assign

Assigns a server profile to an existing node. A profile is assigned to a server slot node or PRIMERGY rack server node. Before assigning a profile to a node, IO channels should be added to the profile.

If a profile is assigned to a server slot and this slot is not empty, the plugged-in server node must be powered off and it must support the specified IO channels of this profile. In case of multi slot profiles the profile must be assigned to the right upper slot of a multi slot CPU blade (e.g. a BX960).

If a profile is assigned to a PRIMERGY rack server, it must be powered off and support the specified IO channels of this profile.

Syntax

viomcli --key=<key> profile assign --id=<integer> --node=<integer>[ --nodwnlinks][ --nopaths][ --nospare][ --ignrun]

Parameters


--id=<integer> or short -i <integer>Server profile ID

--node=<integer> or short -n <integer>Node ID of a server slot or PRIMERGY rack server

--nodwnlinks or short -d OptionalIf set, ignores downlinks

--nopaths or short -p OptionalIf set, ignores network paths for non-IBP hardware

--nospare or short -s OptionalIf set, ignores spare slot settings



--ignrun or short -gOptionalIf set, the target of the assign does not need to be powered off.

Example

viomcli -k 4321 profile assign -i 6 -n 37 --nodwnlinks -p -s

0 0 OK

5.6.9.3 profiles export

Exports one or more server profiles in XML format. By default, the output is standard output and it can be routed to an XML file by using > file name.

Syntax

viomcli --key=<key> --output=xml profiles export [ --id=<list1>][ --groupid=<list2>]

Parameters


--output=xml or short -o xmlChanges the output mode for this method into an XML output that can be analyzed by a binary.

--id=<list1> or short -i <list1>Specifies which server profiles are to be exported.

<id1>[,<id2>, ...]The server profile ID. You can also specify several server profile IDs, separated by commas.

allWith all, all server profiles are exported.

--groupid=<list2> or short -g <list2>Specifies which profile groups are to be exported.

<id1>[,<id2>, ...]The profile group ID. You can also specify several profile group IDs, separated by commas. For each given ID, the profile group and all profiles and profile groups contained in it are exported.



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

allWith all, all profile groups and server profiles are exported.

I Either --id or --groupid must be specified, but not both.

Example

viomcli -k 4321 -o xml profiles export --id=1 > abc.xml

0 0 OK

The first server profile is exported to the XML file abc.xml.

5.6.9.4 profile failover

Starts failover for a server profile.

In case of multi slot profiles the profile must be failed over to a right upper slot of a multi slot CPU blade (e.g. a BX960).

Syntax

viomcli --key=<key> profile failover --node=<integer> --profile=<integer>

Parameters


--node=<integer> or short -n <integer>Node ID

--profile=<integer> or short -p <integer>Server profile ID

Example

viomcli -k 4321 profile failover -n 135 -p 1

0 0 OK



5.6.9.5 profile get

Gets server profile information.

Syntax

viomcli --key=<key> profile get --id=<integer>[ --comment]

Parameters




Example

viomcli -k 4321 profile get --id=7



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.9.6 profiles import

You can edit server profiles that were exported into an XML file and then re-import them using profiles import. Normally, the input is standard input. If you want to import the server profiles from the XML file, you must route the standard input to the XML file. The operating system determines the way in which the standard input is routed:

– On Windows with < <filename> at the end of the command– On Linux with cat <filename>.xml | at the start of the command

I Before you import server profiles from a file, you should use an XML editor to check the syntax of the XML file against the XML schema provided. The XML schema is installed when you install the VIOM Web GUI.

For more information on importing and exporting server profiles as well as formatting export files, see the relevant chapter in the user manual for ServerView Virtual-IO Manager.

Syntax

viomcli --key=<key> profiles import[ --parent=<id>]

Parameters


--parent=<id> or short -p <id>optionalID of the profile group into which the profiles are imported. If not specified, the server profiles are imported into the root group.

Example 1 (Windows)

Command for importing the server profiles from the file serverprofil1:

viomcli -k 4321 profiles import < serverprofil1

0 0 OK

Example 2 (Linux)

Command for importing the server profiles from the file serverprofil1:



cat serverprofil1|viomcli -k 4321 profiles import

0 0 OK

5.6.9.7 profile reassign

Reassigns a modified server profile again to an existing node after it has been modified.

Syntax

viomcli --key=<key> profile reassign --id=<integer> --node=<integer>[ --ignrun]

Parameters



--node=<integer> or short -n <integer>Node ID of a server slot or PRIMERGY rack server.

--ignrun or short -gOptionalIf set, the target of the assign does not need to be powered off.



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.9.8 profile remove

Removes an existing server profile. An assigned server profile cannot be removed.

Syntax

viomcli --key=<key> profile remove --id=<integer>

Parameters



Example

viomcli -k 4321 profile remove --id=7

0 0 OK



5.6.9.9 profile set

Sets values of an existing server profile.

Syntax

viomcli --key=<key> profile set --id=<integer>[ --name=<string>][ -|+virt ][ -|+boot][ --smux=<string>][ --comment=<string>][ --parent=<id>][ --uefi=<string>]

Parameters



--name=<string> or short -n <string>OptionalServer profile name

-|+virt or short -v OptionalIO virtualization usage (-virt: no, +virt: yes, -v: yes)

-|+boot or short -b OptionalBoot menu usage (-boot: no, +boot: yes, -b: yes)

--smux=<string> or short -s <string>OptionalConnecting mezzanine cards to switch fabrics. Here, you specify the fabric to which the LAN daughter card is routed.

fabric3 All paths are routed to fabric 3.

fabric4StandardAll paths are routed to fabric 4.

fabric34LAN1 is routed to fabric 3 and LAN2 to fabric 4.



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05


--parent=<id> or short -p <id>OptionalID of the profile group into which the profile will be moved. If not specified, the profile will not be not moved. To move a server profile to the root group, --parent=1 must be specified.

--uefi=<string> or short -u <string>OptionalDefines the boot interface for IO channels that are configured for booting.

legacyfirst Legacy boot is tried first.

uefionly UEFI boot

uefifirst UEFI boot is tried first.

legacyonlyLegacy boot

Example 1

viomcli -k 4321 profile set --id=7 +boot -c "my new comment"

0 0 OK

Example 2

viomcli -k 1234 profile set --id=8 --smux=fabric34

0 0 OK

Changes the connection from the mezzanine cards to the switch fabrics in the server profile with ID 8 (see example 2 on page 103). After this change, LAN1 is routed to fabric 3 and LAN2 to fabric 4.



5.6.9.10 profiles show

Shows all server profiles.

Syntax

viomcli --key=<key> profiles show

Parameters


The profiles show method has no parameters.

Example 1

viomcli -k 4321 profiles show

Example 2

In accordance with example 2 on page 112, you obtain the following output:

viomcli -k 1234 profiles show



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.9.11 profile unassign

Unassigns a server profile from a node. If the profile is assigned to a server slot and this slot is not empty, the plugged-in server must be powered off so that the profile can be unassigned from the slot. If the profile is assigned to a PRIMERGY rack server, this server must be powered off to unassign the profile.

Syntax

viomcli --key=<key> profile unassign --id=<integer> --node=<integer>[ --force]

Parameters



--node=<integer> or short -n <integer>Node ID of a server slot or a PRIMERGY rack server

--force or short -fOptionalForces the profile to get unassigned.

Example

viomcli -k 4321 profile unassign -i 6 -n 37

0 0 OK



5.6.10 profilegroup object

Methods for maintaining profile groups

5.6.10.1 profilegroup add

Creates a new profile group. The command returns the ID of the newly created profile group to standard output.

Syntax

viomcli --key=<key> profilegroup add --name=<string>[ --comment=<string>][ --parent=<id>]

Parameters


--name=<string> or short -n <string>Name of the profile group


--parent=<id> or short -p <id>OptionalThe ID of the profile group that should be the parent of the new profile group. If not specified, the parent group will be the root group.

Example

viomcli -k 4321 profilegroup add --name=group1

60 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.10.2 profilegroup get

Gets profile group information.

Syntax

viomcli --key=<key> profilegroup get --id=<integer>[ --comment]

Parameters


--id=<integer> or short -i <integer> ID of the profile group


Example

viomcli -k 4321 profilegroup get --id=5

Prof. Group Id Type Prof. Group Path

|---------------|------------|-----------------

5 UserDefined /group1

0 0 OK



5.6.10.3 profilegroup remove

Removes an existing profile group. All groups in this group are also removed (recursively). All server profiles in the removed group (recursively) are moved to the parent group of the removed group.

Syntax

viomcli --key=<key> profilegroup remove --id=<integer>

Parameters


--id=<integer> or short -i <integer> ID of the profile group

Example

viomcli -k 4321 profilegroup remove --id=5

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.10.4 profilegroup set

Sets values of an existing profile group.

Syntax

viomcli --key=<key> profilegroup set --id=<integer>[ --name=<string>][ --comment=<string>][ --parent=<id>]

Parameters


--id=<integer> or short -i <integer>ID of the profile group

--name=<string> or short -n <string>OptionalName of the profile group


--parent=<id> or short -p <id>OptionalID of the profile group into which the profile group will be moved. If not specified, the profile will not be moved . To move a profile group to the root group, --parent=1 must be specified.

Example

viomcli -k 4321 profilegroup set --id=5 --name=new_name

0 0 OK



5.6.10.5 profilegroups show

Shows all profile groups.

Syntax

viomcli --key=<key> profilegroups show

Parameters


Example

viomcli -k 4321 profilegroups show

Prof. Group Id Type Prof. Group Path

|---------------|------------|-----------------



0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.11 servicelan object

Offers methods for maintaining Service LANs.

5.6.11.1 servicelan add

Creates a new Service LAN. The command returns the network ID of the newly created Service LAN to standard output.

Syntax

viomcli --key=<key> servicelan add --name=<string>--node=<integer> --uset=<integer> --vlan=<integer>[ +|- isol][ --comment=<string>]

Parameters




In the case of switch stacking the node ID of the master switch slot has to be specified here. For more information about switch stacking, see Virtual-IO Manager User Guide.

--uset=<integer> or short -u <integer>An uplink set ID

--vlan=<integer> or short -v <integer>A VLAN ID

+|-isol or short -j OptionalDownlink isolation for the Service LAN network (-isol: no, +isol: yes, -j: yes). The default is no downlink isolation.




Example

viomcli -k 4321 servicelan add -n slan_test -o 134 -u 13 -v 110 0 OK

5.6.11.2 servicelan get

Gets information about a Service LAN.

Syntax

viomcli --key=<key> servicelan get --id=<integer>[ --comment]

Parameters


--id=<integer> or short -i <integer>The network ID of the Service LAN


Example

viomcli -k 4321 servicelan get -i 1

Netw.Id Netw.Name Node Id Uplink Set Id Slots VLAN Id Isolation|--------|----------|--------|--------------|------|--------|--------1 slan_test 211 1 1 No0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.11.3 servicelan remove

Removes an existing Service LAN.

Syntax

viomcli --key=<key> servicelan remove --id=<integer>

Parameters



Example

viomcli -k 4321 servicelan remove -i 15

0 0 OK



5.6.11.4 servicelan set

Sets values of an existing Service LAN.

Syntax

viomcli --key=<key> servicelan set --id=<integer>[ --name=<string>][ --uset=<integer>][ --vlan=<integer>][ +|- isol][ --comment=<string>]

Parameters




--uset=<integer> or short -u <integer>OptionalAn uplink set ID

--vlan=<integer> or short -v <integer>OptionalA VLAN ID

+|-isol or short -j OptionalDownlink isolation for the Service LAN network (-isol: no, +isol: yes, -j: yes).


Example

viomcli -k 4321 servicelan set -i 15 -n "slan_test_new" -u 13

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.12 servicevlan object

Offers methods for maintaining Service VLANs.

5.6.12.1 servicevlan add

Creates a new Service VLAN. The command returns the network ID of the newly created Service VLAN to standard output.

Syntax

viomcli --key=<key> servicevlan add --name=<string>--node=<integer> --uset=<integer> --vlan=<integer>[+|-isol][ --comment=<string>]

Parameters



--node=<integer> or short -o <integer>Node ID of a switch slot

In the case of switch stacking the node ID of the master switch slot has to be specified here. For more information about switch stacking, see Virtual-IO Manager User Guide.



+|-isol or short -j OptionalDownlink isolation for the Service VLAN network (-isol: no, +isol: yes, -j: yes). The default is no downlink isolation.




Example

viomcli -k 4321 servicevlan add -n svlan_test -o 211 -u 1 -v 1120 0 OK

5.6.12.2 servicevlan get

Gets information about a Service VLAN network.

Syntax

viomcli --key=<key> servicevlan get --id=<integer>[ --comment]

Parameters


--id=<integer> or short -i <integer>The network ID of the Service VLAN


Example

viomcli -k 4321 servicevlan get -i 2

Netw.Id Netw.Name Node Id Uplink Set Id Slots VLAN Id Isolation|--------|----------|--------|--------------|------|--------|--------2 svlan_test 211 1 11 No0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.12.3 servicevlan remove

Removes an existing Service VLAN network.

Syntax

viomcli --key=<key> servicevlan remove --id=<integer>

Parameters



Example

viomcli -k 4321 servicevlan remove -i 15

0 0 OK



5.6.12.4 servicevlan set

Sets values of an existing Service VLAN network.

Syntax

viomcli --key=<key> servicevlan set --id=<integer>[ --name=<string>][ --uset=<integer>][ --vlan=<integer>][ +|- isol][ --comment=<string>]

Parameters





--vlan=<integer> or short -v <integer>OptionalA VLAN ID

+|-isol or short -j OptionalDownlink isolation for the Service VLAN network (-isol: no, +isol: yes, -j: yes).


Example

viomcli -k 4321 servicevlan set -i 15 -n "svlan_test_new" -u 13

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.13 session object

Offers methods for managing the ServerView Connector Service (SCS) session.

5.6.13.1 session close

Closes the SCS session. Normally you do not need this method, but for security reasons you may use it to destroy the SCS session immediately.

Syntax

viomcli --key=<key> session close

Parameters


The session close method has no parameters.

Example

viomcli -k 4321 session close

0 0 OK



5.6.14 uplinkset object

Offers methods for maintaining uplink sets.

5.6.14.1 uplinkset add

Creates a new uplink set. The command returns the ID of the newly created uplink set to standard output.

Syntax

viomcli --key=<key> uplinkset add --name=<string>--nodeid=<integer> +|-fover +|-ldp[ +|-lacp][ +|-igmp]--speed=<string>[ --dcbgroup=<list1>][ --dcbgroup=<list2>] ...

Parameters


--name=<string> or short -n <string>Uplink set name

--nodeid=<integer> or short -o <integer>Node ID of a switch slot. For a new uplink set to be created, an IBP connection blade must be plugged into the switch slot.

In the case of switch stacking the node ID of the master switch has to be specified here. For more information about switch stacking, see Virtual-IO Manager User Guide.

-|+fover or short -f Failover usage (-fover: no, +fover: yes, -f: yes)

-|+ldp or short -l Link down propagation usage (-ldp: no, +ldp: yes, -l: yes)

-|+lacp or short -a OptionalLink Aggregation Control Protocol usage (-lacp: no, +lacp: yes, -a: yes). The default is no.



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

-|+igmp or short -g OptionalIGMP Snooping usage (-igmp: no, +igmp: yes, -g: yes). The default is yes.

--speed=<string> or short -s <string>Link speed:

autoautomatic negotiation

10m10 Mbit/s

100m100 Mbit/s

--dcbgroup=<list> or short -w <list>OptionalComma-separated list of DCB parameters.

<weight>[,<purpose>][,<priority level>]



<purpose>Optional

fcoeFCoE

iscsiiSCSI

I For a PY CB Eth Switch 10/40Gb 18/8+2 (SBAX3) connection blade <purpose> should be omitted (only FCoE and priority level 3 are supported).

<priority level >OptionalPriority level of the priority group (integer)

Possible values between 0 and 7. Defaults are 3 for FCoE respectively 4 for iSCSI. One or more priority levels may be specified separated by commas.



I For a PY CB Eth Switch 10/40Gb 18/8+2 (SBAX3) connection blade <priority level> should be omitted (only FCoE and priority level 3 are supported).

I The --dcbgroup parameter may appear several times in a command line once for each priority group.

Example

viomcli -k 4321 uplinkset add -n test -o 29 -f -l -s auto

40 0 OK

In this example, 4 is the ID of the newly created uplink set, which is written to standard output. The command status information (0 0 OK) is written to standard error. If an error happens (return code not 0), no ID is written to standard output.

5.6.14.2 uplinkset get

Gets uplink sets information.

Syntax

viomcli --key=<key> uplinkset get --id=<integer>[ --dcbgroups]

Parameters


--id=<integer> or short -i <integer>Uplink set ID

--dcbgroups or short -wOptionalShows all priority groups associated with the uplink set.



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

Example 1

viomcli -k 4321 uplinkset get --id=10

Id Set Name Link Speed Failover Link Dwn. Prop. Used by Netw.|---|---------|-----------|---------|----------------|--------------10 NET_2 Auto Yes Yes 10

0 0 OK

Example 2

In this example the uplink set is used for Fibre Channel over Ethernet.

viomcli -k 4321 uplinkset get --id=10 --dcbgroups

Priority Level Weight Purpose|---------------|-------|------[3] 50 FCoE

0 0 OK

5.6.14.3 uplinkset remove

Removes an existing uplink set.

Syntax

viomcli --key=<key> uplinkset remove --id=<integer>

Parameters



Example

viomcli -k 4321 uplinkset remove --id=1

0 0 OK



5.6.14.4 uplinkset set

Sets values of an existing uplink set.

Syntax

viomcli --key=<key> uplinkset set --id=<integer>[ --nodeid=<integer>][ +|-fover ][ +|-ldp][ -|+dcbuse][ --speed=<string>][ --dcbgroup=<list1>][ --dcbgroup=<list2>] ...

Parameters



--nodeid=<integer> or short -o <integer>OptionalNode ID

-|+fover or short -f OptionalFailover usage (-fover: no, +fover: yes, -f: yes)

-|+ldp or short -l OptionalLink down propagation usage (-ldp: no, +ldp: yes, -l: yes)

-|+dcbuse or short -b OptionalEnables or disables Data Center Bridging (-dcbuse: disabled, +dcbuse: enabled, -b: enabled)

I -dcbuse will delete all priority groups of the uplink set.

--speed=<string> or short -s <string>OptionalLink speed:

autoautomatic negotiation



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

10m10 Mbit/s

100m100 Mbit/s

--dcbgroup=<list> or short -w <list>OptionalComma-separated list of DCB parameters.

<weight>[,<purpose>][,<priority level>]



<purpose>Optional

fcoeFCoE

iscsiiSCSI

<priority level >OptionalPriority level of the priority group (integer)

Possible values between 0 and 7. Defaults are 3 for FCoE respectively 4 for iSCSI. One or more priority levels may be specified separated by commas.

I The --dcbgroup parameter may appear several times in a command line once for each priority group.

Existing priority groups will be deleted.

Example

viomcli -k 4321 uplinkset set --id=10 --speed=auto

0 0 OK



5.6.14.5 uplinksets show

Shows the uplink sets of a node.

Syntax

viomcli --key=<key> uplinksets show --node=<integer>

Parameters


--node=<integer> or short -n <integer>Node ID of a switch slot

Example

viomcli -k 4321 uplinksets show -n 29

Uplink Set Id Set Name Link Speed Failover Link Dwn. Prop. Used by Netw. LACP IGMP Snooping DCB|--------------|----------|-----------|----------|---------------|--------------|- --|-------------|---1 test Auto No Yes No No Yes No0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.15 vlannet object

Offers methods for maintaining VLAN networks.

5.6.15.1 vlannet add

Creates a new VLAN network. The command returns the network ID of the newly created VLAN network to standard output.

Syntax

viomcli --key=<key> vlannet add --name=<string> --node=<integer> --uset=<integer> --vlan=<integer> +|-native[ +|- isol][ --comment=<string>]

Parameters




In the case of switch stacking the node ID of the master switch has to be specified here. For more information about switch stacking, see Virtual-IO Manager User Guide.



-|+native or short -a Native (-native: no, +native: yes, -a: yes)

+|-isol or short -j OptionalDownlink isolation for the VLAN network (-isol: no, +isol: yes, -j: yes). The default is no downlink isolation.




Example

viomcli -k 4321 vlannet add -n vlan_test -o 134 -u 13 -v 1 +native -c vtest

80 0 OK

In this example, 8 is the ID of the newly created VLAN network, which is written to standard output. The command status information (0 0 OK) is written to standard error. If an error happens (return code not 0), no ID is written to standard output.

5.6.15.2 vlannet get

Gets information about a VLAN network.

Syntax

viomcli --key=<key> vlannet get --id=<integer>[ --comment]

Parameters




Example

viomcli -k 4321 vlannet get -i 15

Netw. Id Netw. Name Node Id Uplink Set Id Slots VLAN Id Native Isolation |---------|-----------|--------|--------------|------|--------|-------|---------15 vlan_test 134 13 1 Yes No

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.15.3 vlannet remove

Removes a VLAN network.

Syntax

viomcli --key=<key> vlannet remove --id=<integer>

Parameters



Example

viomcli -k 4321 vlannet remove -i 15

0 0 OK



5.6.15.4 vlannet set

Sets values of an existing VLAN network.

Syntax

viomcli --key=<key> vlannet set --id=<integer>[ --name=<string>][ --uset=<integer>][ -|+native][ +|- isol][ --comment=<string>]

Parameters





-|+native or short -a OptionalNative (-native: no, +native: yes, -a: yes)

+|-isol or short -j OptionalDownlink isolation for the VLAN network (-isol: no, +isol: yes, -j: yes).


Example

viomcli -k 4321 vlannet set -i 15 -n "vlan_test_new" -native -u 13

0 0 OK



© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k05

5.6.15.5 vlannets show

Shows VLAN networks of a node.

Syntax

viomcli --key=<key> vlannet show --node=<integer>

Parameters



Example

viomcli -k 4321 vlannets show -o 134

Netw. Id Netw. Name Node Id Uplink Set Id Slots VLAN Id Native Isolation|---------|-----------|--------|--------------|------|--------|-------|--------15 vlan_test 134 13 1 Yes No

0 0 OK


6 Error and return codesAfter executing a command, you always receive a message in the format:

<major code> <minor code> <message string>

If the command was executed successfully, the following message is displayed:

0 0 OK

If the execution of the command ends with an error, the message string contains an error message string. This string is normally a short text message. You can set the viomcli option --longtext or --system to get a long text or system message (see section "viomcli options" on page 29).

6.1 Error codes

VIOM CLI error codes are split into major and minor codes. The following major code categories are defined by VIOM CLI:

Error codes and messages are printed to STDERR, whereas all other output is printed to STDOUT.

Major code Category

< 1000 VIOM/SCS-specific error message

1000 General errors

1100 CLI option errors

1200 CLI command errors

1300 “Object value missing” errors

1400 “Object value unknown” errors

Table 8: Error codes


Error codes

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k06

6.1.1 Major code 1000

Major code 1000 is a category of general errors. The following minor codes are defined:

Minor Code

Name Description

0 unknown error The reason for this error is unknown, see the server log file for more information

1 call failed The SCS function call failed, see the server log file for more information

2 I/O error Communication to SCS could not be established or was dropped

3 option value is missing A value for a given option was not specified

4 type mismatch The type of the option value given is not as expected

5 general parsing error An unknown option has been given

6 unparsable part A character sequence was given which could not be parsed

7 syntax error An expected option or value was not specified

8 access to file denied Access to a file was denied

9 unsupported charset The specified charset is not supported

10 unsupported language The specified language is not supported

11 open session failed The attempt to open a session to SCS has failed

Table 9: Major code 1000


Error codes


Major code 1100 is a category of CLI option errors. The following minor codes are defined:


Major code 1200 is a category of CLI command errors. The following minor codes are defined:


Major code 1300 is a category VIOM object and method errors which signals that an object value is missing. The following minor codes are defined:

Minor code

Name Description

1 invalid output format The specified output format to be used for rendering is not supported

2 incomplete access data No user key given, or an invalid user key was given, or there is no user profile for this user key

3 duplicate user key The given user key already exists and cannot be used for a new profile


Minor code

Name Description

1 unknown logger level The log level specified is not known


Minor code

Name Description

1 missing node ID A node ID is required

2 missing uplink set ID An uplink set ID is required



Error codes

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k06

3 missing password A password is required

4 missing port A port is required

5 missing ports Ports are required

6 missing protocol type A protocol type is required

7 missing user name A user name is required

8 missing profile name A server profile name is required

9 missing virtual usage A value for virtualization usage is required

10 missing profile id A server profile ID is required

11 missing network name A network name is required

12 missing network id A network ID is required

13 missing VLAN id A VLAN ID is required

14 missing vlan native

15 missing uplink set name An uplink set name is required

16 missing failover usage A value for failover usage is required

17 missing link down propagation

A value for link down propagation is required

18 missing link speed A link speed is required

19 missing channel type A channel type is required

20 missing board number A board number is required

21 missing board type A board type is required

22 missing port number A port number is required

23 missing power mode A power mode is required

24 missing boot menu usage A boot menu usage is required

25 missing file name A file name is required

26 missing profilegroup name A profile group name is required

27 missing profilegroup ID A profilegroup ID is required

28 missing boot device usage A boot device usage is required

Minor code

Name Description



Error codes


Major code 1400 is a category of VIOM object and method errors which signals that a given object value is unknown. The following minor codes are defined:

29 missing io channel usage An IO channel is required

Minor code

Name Description

1 unknown speed value The specified speed value is not known

2 unknown protocol value The specified protocol value is not known

3 unknown io channel type The specified IO channel type is not known

4 unknown power mode The specified power mode is not known

5 unknown boot mode The specified boot mode is not known

6 unknown smux mode value

A smux mode value is required

7 unknown index type An index type is required

8 unknown UEFI type An UEFI type is required


Minor code

Name Description



Return codes

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k06

6.2 Return codes

The return code of the viomcli binary is in the range of 0 to 255 and calculated from the major and minor error codes:

A return code of zero means that no errors have occurred and execution was successful.

Major code

Minor code

Return code Description

< 1000 all 1 All VIOM/SCS-specific error messages

1000 0 21 No Response

1000 1 22 Call failed

1000 2 23 I/O error

1000 3 24 Option value is missing

1000 4 25 Type mismatch

1000 5 26 General parsing error

1000 6 27 Unparsable part

1000 7 28 Syntax error

1000 8 29 Access to file denied

1000 9 30 Unsupported charset

1000 10 31 Unsupported language

1000 11 32 Open session failed

1100 all 2 All CLI option errors

1200 all 3 All CLI command errors

1300 all 4 All “object value missing” errors

1400 all 5 All “object value unknown” errors

Table 14: Return codes


7 Further informationThis chapter provides further information on:

– The console log and the log file– The INI file– The environment variable VIOMCLI– Using telnet– The client server protocol

7.1 Console log and log file

The console log and the logfile have the same format. Columns are separated by spaces and the output will look similar to this:

2010-02-08 16:31:27.562 4 1 pool created2010-02-08 16:31:27.593 3 1 server ready2010-02-08 16:31:35.250 4 1 locking pool object 300356362010-02-08 16:31:35.281 4 12 server thread started2010-02-08 16:31:35.281 5 12 socket streams opened2010-02-08 16:31:35.296 5 12 Command Line Parser: found 4 elements2010-02-08 16:31:35.296 5 12 Command Line Parser: element index 12010-02-08 16:31:35.296 5 12 Command Line Parser: 2 matches found

Column Description

1 Date

2 Time

3 Log level:1 severe2 important3 info4 debug low5 debug extreme

4 Thread ID:The main thread of the server has a thread ID of 1. The server starts a new thread for each client. All messages with the same thread ID are caused by the same client session.

5 Message

Table 15: Column descriptions


INI file

© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k07

In the example above, the message “server ready” is logged by the main thread, and the message “socket streams opened” with ID 12 is logged by the worker thread which is servicing a client request. All subsequent messages with ID 12 are caused by the same client session. So if you are running more than one script at the same time you will be able to track down which messages belong together.

The log file is rotated once it exceeds 10 MB; this is a fixed limit. The old log file will be named <logfile_name>.0. If a file with this name already exists it will be overwritten.

7.2 INI file

The viomcli INI file is normally stored in the <userhome>/viomcli directory and has the name viomcli.ini (<userhome>: environment variable HOMEPATH under Windows or Home under LINUX).

The default content is:

[general]debug=0params=

[server]addr=127.0.0.1port=51000eof=01 0D 0A 0D 0A

Value Description

debug 0 no debugging (default)1 activates debug output of viomcli binary

params Command line parameters which should be used in every call (output options, user key, etc.)Example: params=--key=1234 or params=-k 1234

addr The IP address of the VIOM CLI server (default 127.0.0.1, which is the local host)

port The port of the VIOM CLI server (default 51000)

eof The EOF sequence as hex values (default 01 0D 0A 0D 0A). This sequence is sent by the server to denote the end of transmission.

Table 16: Content of the INI file


Environment variable

7.3 Environment variable

You may pass options which should be used in every call via the environment variable VIOMCLI. This is another method to do so, other than via the params value in the INI file.

The VIOMCLI environment variable will be evaluated first, so it will overrule the INI settings. Parameters added via environment variable or INI file can be overruled by parameters in the command line.

Example

On Windows set:

set VIOMCLI=--key=1234

or:

set VIOMCLI=-k 1234


© c

ogni

tas.

Ges

ells

chft

für

Tech

nik-

Dok

umen

tatio

n m

bH 2

009

Pfa

d: P

:\FT

S-P

S\V

IOM

_CLI

_3.8

\Han

dbuc

h\us

\vio

mcl

i-en.

k07