Anvil-manage-vnc-pipe: Difference between revisions
Jump to navigation
Jump to search
Created page with "{{man_header}} <ToDo> {{footer}}" |
No edit summary |
||
| Line 1: | Line 1: | ||
{{man_header}} | {{man_header}} | ||
= NAME = | |||
anvil-manage-vnc-pipe - builds or destroys "VNC pipe" | |||
= SYNOPSIS = | |||
; To open a VNC pipe: | |||
: '''''' anvil-manage-vnc-pipe --server <libvirt_domain_name> [ '''--server-vnc-port''' <vnc_port> ] --open | |||
; To close a VNC pipe: | |||
: '''''' anvil-manage-vnc-pipe --server <libvirt_domain_name> | |||
= DESCRIPTION = | |||
A VNC pipe consists of 1 instance of websockify that translates the VNC protocol to websocket protocol, which allows the VNC data to travel over a protocol that the browser understands. '''anvil-manage-vnc-pipe''' manages the lifespan of a VNC pipe with the given server identifier. | |||
= OPTIONS = | |||
; --open | |||
: Opens a VNC pipe with the given target server. Close is assumed when this option is not provided. | |||
; --server <libvirt_domain_name> | |||
: An alternative to the ''--server-uuid'' option that makes this script do the server name resolution. One of ''--server'' or ''--server-uuid'' is required. | |||
; --server-uuid <libvirt_domain_uuid> | |||
: Specifies a libvirt domain as VNC data source. | |||
; --server-vnc-port <vnc_port> | |||
: Specifies the target libvirt domain VNC port instead of letting the script do the detection. | |||
= EXIT STATUS = | |||
; '''0''' | |||
: Successful program execution. | |||
; '''1''' | |||
: VNC pipe setup process failed. It's possible to reuse the command to try again without needing to worry about duplicating component(s). The script is capable of detecting existing usable component(s) and only setup the missing piece(s). | |||
= AUTHOR = | |||
Written by Yanhao Lei, Alteeve staff and the Anvil! project contributors. | |||
= REPORTING BUGS = | |||
Report bugs to users@clusterlabs.org | |||
{{footer}} | {{footer}} | ||
Latest revision as of 15:26, 1 October 2024
|
Alteeve Wiki :: Man Pages :: Anvil-manage-vnc-pipe |
NAME
anvil-manage-vnc-pipe - builds or destroys "VNC pipe"
SYNOPSIS
- To open a VNC pipe
- ' anvil-manage-vnc-pipe --server <libvirt_domain_name> [ --server-vnc-port' <vnc_port> ] --open
- To close a VNC pipe
- ' anvil-manage-vnc-pipe --server <libvirt_domain_name>
DESCRIPTION
A VNC pipe consists of 1 instance of websockify that translates the VNC protocol to websocket protocol, which allows the VNC data to travel over a protocol that the browser understands. anvil-manage-vnc-pipe manages the lifespan of a VNC pipe with the given server identifier.
OPTIONS
- --open
- Opens a VNC pipe with the given target server. Close is assumed when this option is not provided.
- --server <libvirt_domain_name>
- An alternative to the --server-uuid option that makes this script do the server name resolution. One of --server or --server-uuid is required.
- --server-uuid <libvirt_domain_uuid>
- Specifies a libvirt domain as VNC data source.
- --server-vnc-port <vnc_port>
- Specifies the target libvirt domain VNC port instead of letting the script do the detection.
EXIT STATUS
- 0
- Successful program execution.
- 1
- VNC pipe setup process failed. It's possible to reuse the command to try again without needing to worry about duplicating component(s). The script is capable of detecting existing usable component(s) and only setup the missing piece(s).
AUTHOR
Written by Yanhao Lei, Alteeve staff and the Anvil! project contributors.
REPORTING BUGS
Report bugs to users@clusterlabs.org
| Any questions, feedback, advice, complaints or meanderings are welcome. | |||
| Alteeve's Niche! | Alteeve Enterprise Support | Community Support | |
| © 2025 Alteeve. Intelligent Availability® is a registered trademark of Alteeve's Niche! Inc. 1997-2025 | |||
| legal stuff: All info is provided "As-Is". Do not use anything here unless you are willing and able to take responsibility for your own actions. | |||