NAME¶
hvcsadmin —
hypervisor virtual console
server administration utility
SYNOPSIS¶
hvcsadmin -all
[-noisy] |
[-noisy] |
hvcsadmin -close
hvcs<index>
[-noisy] |
[-noisy] |
hvcsadmin -console
partition
[-noisy] |
[-noisy] |
hvcsadmin -node
hvcs<index>
[-noisy] |
[-noisy] |
hvcsadmin -rescan
[-noisy] |
[-noisy] |
hvcsadmin -status
[-noisy] |
[-noisy] |
DESCRIPTION¶
This is the IBM hypervisor virtual console server (
hvcs) administration
utility.
OPTIONS¶
- -all
- Close all open vty-server adapter connections.
Inclusion of a single ‘-noisy’ flag will
direct the utility to output a list of all the adapters that were
closed.
- -close
hvcs<index>
- Close the vty-server adapter connection that maps to the
hvcs device node specified in the option.
By default this operation only exhibits output on error. It is silent on
success and silent if the adapter is already closed. When accompanied by a
‘-noisy’ flag this option will output the
device to adapter mapping and a message indicating that the adapter has
been closed.
- -console
partition
- Which /dev/hvcs<index> node provides the console for
the option specified partition? This option takes a partition number and
returns a status string which contains the device node that maps to the
target partition's slot zero vty-server adapter [A console adapter is
always in slot zero].
Inclusion of a single ‘-noisy’ flag does not
change the default output of this option.
- -help
- Output the utility help text.
- -node
hvcs<index>
- Which vty-server adapter is mapped to the option specified
/dev/hvcs<index> node? This option takes a device node and returns a
status string which contains the vty-server adapter mapped to that node.
Inclusion of a single ‘-noisy’ flag does not
change the default output of this option.
- -noisy
- This directive is optional. Without a
‘-noisy’ directive the hvcsadmin utility is
in silent mode by default (except in the case of errors and output
requests). The output verbosity of the utility is managed by stacking
‘-noisy’ directives. A single instance of
‘-noisy’ indicates that the utility should
output in status mode. A second instance of
‘-noisy’ indicates that the utility should
output in verbose mode. Verbose mode is generally used for script
tracing and won't be used by a casual user unless problems arise.
- -rescan
- Direct the hvcs driver to rescan partner information for
all vty-server adapters it manages. This may expose additional adapters
and partners.
- -status
- Outputs a table with each row containing a vty-server,
adapter, its /dev/hvcs<index> device node mapping, and the adapter
connection status. "vterm_state:0" means it is free/disconnected
and "vterm_state:0" means the vty-server is connected to its vty
partner adapter.
An example of hvcsadmin -status output follows:
vty-server@30000003 partition:1 slot:2 /dev/hvcs0 vterm-state:0
vty-server@30000004 partition:15 slot:0 /dev/hvcs1 vterm-state:0
When this option is accompanied by a ‘-noisy’
flag it will output a line for each hvcs device node which doesn't have a
current vty-server adapter mapping as well as the status demonstrated
above.
- -version
- Out the hvcsadmin script's version number.
AUTHOR(S)¶
Ryan S. Arnold ⟨rsa@us.ibm.com⟩