NGPORTAL(8) System Manager's Manual NGPORTAL(8) NAME ngportal -- netgraph portal gun to create connected wormhole pairs SYNOPSIS ngportal [-n] [-j jail] spec1 [spec2] DESCRIPTION The ngportal utility creates an ng_wormhole(4) and then opens it in a dif- ferent jail to connect and complete the pair. Additionally, as a conve- nience, ngportal can name one or both wormholes for ngctl(8), as well as connect one or both sides event horizon to an already existing netgraph(4) node. The following options are available: -n Disable automatic loading of ng_socket(4) and ng_wormhole(4) kernel modules. -j jail Perform the actions inside the jail. This becomes the new default jail when none is specified. Specifications are colon separated strings with the following components, all of which are optional: [jail]: [name]: [node:hook] jail name or id of jail that has been created. name a name to provide the wormhole in the jail referenced above if present or the default. node:hook a netgraph node and one of its hooks to connect to the evthorizon of the wormhole in the jail referenced above if present or the default. jail if left unspecified this means the location where you are running ngportal. In fact you will confuse the portal gun if you specify (by name or jail ID) the jail where you are running ngportal. But wormhole pairs can not be in the same jail. So at least one jail must be specified. Trailing colons are optional, but to specify a wormhole name you must have a leading colon even if you do not provide a jail. The node:hook pair re- ally must be that. It is not a path with hook. It must simply identify the name or ID of a node and the name of a hook on that node. EXIT STATUS The ngportal utility exits 0 on success, and >0 if an error occurs. EXAMPLES Create a wormhole pair from the system to jail test: # ngportal test Do the same but name the wormholes this time: # ngportal :wh0a test:wh0b Assuming you have an ng_bridge(4) named br0 where you are running ngportal and an ng_eiface(4) named ngeth0 in the jail test they can be connected via wormhole to each other. The following will name the wormholes and connect them: # ngportal :wh0a:br0:link test:wh0b:ngeth0:ether All previous examples used a default jail. But to connect two ng_eiface(4) in two peer jails (ngeth0a in left and ngeth0b in center) use the follow- ing: # ngportal left::ngeth0a:ether center::ngeth0b:ether SEE ALSO netgraph(4), ng_bridge(4), ng_eiface(4), ng_wormhole(4), ngctl(8) AUTHORS David Marker <dave@freedave.net> BUGS Until there is a way for a process to get the jail ID in which it is run- ning, the only way to correctly refer to that jail is to leave it unspeci- fied. FreeBSD ports 15.quarterly April 4, 2025 NGPORTAL(8)
NAME | SYNOPSIS | DESCRIPTION | EXIT STATUS | EXAMPLES | SEE ALSO | AUTHORS | BUGS
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ngportal&sektion=8&manpath=FreeBSD+Ports+15.1.quarterly>