mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-05-31 10:06:39 +00:00
99 lines
2.4 KiB
Plaintext
99 lines
2.4 KiB
Plaintext
=head1 NAME
|
|
|
|
B<makegocons> - Register or unregister the node in the goconserver service
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<makegocons> [B<-V|--verbose>] [B<-d|--delete>] [I<noderange>]
|
|
|
|
B<makeconservercf> [B<-h|--help|-v|--version>]
|
|
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<makegocons> command will start the goconserver service if it is not started, then
|
|
send the REST request to create or delete the session resource in the goconserver service. The session
|
|
information including the session command or ssh connection parameters (for openbmc) is generated by xcat
|
|
based on the records in the related tables (e.g. nodehm, ipmi, ppc, openbmc).
|
|
|
|
By default B<makegocons> will register the session for all of the nodes in xcat.
|
|
|
|
If a I<noderange> is specified, only the session in the specified scope will be affected, goconserver
|
|
service will not be restarted and the other session will not be disconnected. This is the advantage
|
|
of goconserver over the conserver service with B<makeconservercf>.
|
|
|
|
If B<-d> is specified, B<makegocons> will remove the session in the goconserver service.
|
|
|
|
In the case of a hierarchical cluster (i.e. one with service nodes) B<makegocons> will determine
|
|
which nodes will have their consoles accessed from the management node and which from a service node
|
|
(based on the nodehm.conserver attribute).
|
|
|
|
For openbmc which uses ssh as the terminal session connection method, goconserver can help save the system
|
|
resources as goconserver could handle the ssh connection within goroutine which is more light-weighted than the command process.
|
|
|
|
B<Note:> goconserver is an experimental feature, it will not be installed with xcat and will only support the systemd based systems.
|
|
Download and setup the rpm or deb package manually. Release link:
|
|
|
|
https://github.com/chenglch/goconserver/releases
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 10
|
|
|
|
=item B<-d|--delete>
|
|
|
|
Delete rather than add or refresh the nodes specified as a noderange.
|
|
|
|
=item B<-v|--version>
|
|
|
|
Display version.
|
|
|
|
=item B<-V|--verbose>
|
|
|
|
Verbose mode.
|
|
|
|
=item B<-h|--help>
|
|
|
|
Display usage message.
|
|
|
|
=back
|
|
|
|
|
|
=head1 RETURN VALUE
|
|
|
|
=over 2
|
|
|
|
=item 0.
|
|
The command completed successfully.
|
|
|
|
=item 1.
|
|
An error has occurred.
|
|
|
|
=back
|
|
|
|
=head1 EXAMPLES
|
|
|
|
=over 2
|
|
|
|
=item 1.
|
|
To create goconserver configuration for all the nodes.
|
|
|
|
makegocons
|
|
|
|
=item 2.
|
|
To create goconserver configuration for nodes node01-node10.
|
|
|
|
makegocons node01-node10
|
|
|
|
=item 3.
|
|
To remove goconserver configuration for node01.
|
|
|
|
makegocons -d node01
|
|
|
|
=back
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<rcons(1)|rcons.1>
|
|
|