File orthos2.1 of Package orthos-client

Overview Repositories Revisions Requests Users Attributes Meta

File orthos2.1 of Package orthos-client (Revision 57d66b516459596d3839f24cea9c5644)

Currently displaying revision 57d66b516459596d3839f24cea9c5644 , Show latest

.\" Man page generated from reStructuredText.
.
.TH "ORTHOS2" "1" "Oct 12, 2021" "" "Orthos2"
.SH NAME
orthos2 \- Orthos Command Line Client Documenation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH BASICS
.sp
The Orthos CLI is a simple interactive shell. You can perform following tasks with the Orthos CLI:
.INDENT 0.0
.IP \(bu 2
executing complex queries such as “which machines have more than 4 CPUs” and are reserved by Ließchen Müller,
.IP \(bu 2
reserving a machine (only for yourself!),
.IP \(bu 2
viewing detailed machine information (such as dmidecode, lspci, lsmod or hwinfo),
.IP \(bu 2
turning power on/off or just reboot a machine,
.IP \(bu 2
editing machine data.
.UNINDENT
.SH INSTALL THE CLI
.sp
Python 3 is recommended.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
zypper in orthos\-client
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In the Orthos Web Client you will find also the download link \fBDownload CLI\fP to the CLI, here you have the possibility
to download the suitable client for your distribution(.rpm). The button is in the top right corner.
.SH CONNECTING THE CLI TO THE ORTHOS SERVER
.sp
The CLI has several options how you can set up the connection to the Orthos server and adapt it to your needs.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
you_machine:~ # orthos \-\-help
usage: orthos [\-h] [\-H HOST] [\-P PORT] [\-U USER] [\-\-password PASSWORD]
              [\-\-token TOKEN] [\-D] [\-L FILE] [\-\-no\-pager] [\-p] [\-F IFS]
              [\-q] [\-v] [\-\-timezone TZ]

Orthos command line interface.

optional arguments:
  \-h, \-\-help            show this help message and exit
  \-H HOST, \-\-host HOST  use the hostname specified on the command line instead
                        of the one in the config file
  \-P PORT, \-\-port PORT  use the port specified on the command line instead of
                        the one in the config file
  \-U USER, \-\-user USER  use the username specified
  \-\-password PASSWORD   use this password for automatic authentication (e.g.
                        for scripting)
  \-\-token TOKEN         use this token for automatic authentication (e.g. for
                        scripting); \-U/\-\-password options will be ignored
  \-D, \-\-debug           write debugging output
  \-L FILE, \-\-logfile FILE
                        use that together with \-D to log the debug output in a
                        file rather than the console
  \-\-no\-pager            do not use pager when showing results
  \-p, \-\-plain\-output    print plain output (e.g. for scripting)
  \-F IFS, \-\-ifs IFS     set internal field separator (only useful in
                        combination with \-p; default is $OIFS)
  \-q, \-\-quiet           makes command line client quiet
  \-v, \-\-version         print version output
  \-\-timezone TZ         set the local time zone (default is "Europe/Berlin")
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example for the connection to the Orthos Server:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
your_machine:~ # orthos \-H https://orthos\-next.arch.suse.de
(orthos 2.0.0)
.ft P
.fi
.UNINDENT
.UNINDENT
.SH ORTHOSRC CONFIGURATION FILE
.sp
The orthos package installs an empty configuration file in /etc/orthosrc.
Once you connected to the orthos server, it is recommended to copy this
file to your local config directory: ~/.config/orthosrc
and adapt the file to your needs
.SH ORTHOS COMMANDS
.sp
HELP
.sp
Provides help and shows you an overview of the available Orthos CLI commands.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(orthos 2.0.0) help
Commands are:

INFO                 Retrieve information about a machine.
POWER                Power cycles a machine.
REGENERATE           Regenerate machine\-related or service files.
RESCAN               Rescan a machine.
SERVERCONFIG         Show server configuration.
RESERVATIONHISTORY   Show reservation history of a machine.
ADD                  Adds information to the database.
RELEASE              Release machines.
QUERY                Retrieve information about a machine.
RESERVE              Reserve machines.
SETUP                Automatic machine setup.
DELETE               Removes information from the database.
ALIAS                Define own aliases.
AUTH                 Request authorisation manually.
EXIT                 Exit program.
HELP                 Provides help.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The HELP can also show you the help for certain commands.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(orthos 2.0.0) help info
Command to get information about a machine.

Usage:
    INFO <fqdn>

Arguments:
    fqdn \- FQDN or hostname of the machine.

Example:
    INFO foo.suse.de
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
INFO
.sp
Retrieve information about a machine.
.sp
Command description:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(orthos 2.0.0) help info
Command to get information about a machine.

Usage:
    INFO <fqdn>

Arguments:
    fqdn \- FQDN or hostname of the machine.

Example:
    INFO foo.suse.de
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
POWER
.sp
Power cycles a machine.
.sp
Command description:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(orthos 2.0.0) help power
Command to power cycle machines or the get the current status.

Usage:
    POWER <fqdn> <action>

Arguments:
    fqdn   \- FQDN or hostname of the machine.
    action \- Specify new power state. Actions are:

on                 : Power on.
off                : Power off via SSH. If didn\(aqt succeed, use remote power.
off\-ssh            : Power off via SSH only.
off\-remotepower    : Power off via remote power only.
reboot             : Reboot via SSH. If didn\(aqt succeed, use remote power.
reboot\-ssh         : Reboot via SSH only.
reboot\-remotepower : Reboot via remote power only.
status             : Get power status.

Example:
    POWER foo.suse.de reboot
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
REGENERATE
.sp
Regenerate machine\-related or service files.
.sp
Command description:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(orthos 2.0.0) help REGENERATE
Command to regenerate machine\-related files or configuration files for various services.

Usage:
    REGENERATE <fqdn> <option>
    REGENERATE <service>

Arguments:
    fqdn    \- FQDN or hostname of the machine.
    option  \- Specify what machine\-related file should be regenerated.
                Options are:

motd          : Message of the day.

service \- Specify which service configuration file shoud be regenerated.
       Options are:
             dhcp          : DHCP configuration files (superusers only).
             serialconsole : Serial console files (superusers only).

Example:
    REGENERATE foo.suse.de motd
    REGENERATE dhcp
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
ADD
.sp
Adds information to the database.
.sp
Command description:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(orthos 2.0.0) help add
Adds items to the database. All information will be queried interactively.

Usage:
    ADD <item> [args*]

Arguments:
    item \- Specify the item which should be added. Items are:

machine                       : Add a machine (superusers only).
annotation <fqdn>             : Add an annotation to a specific
                                machine (no bugreports).
serialconsole <fqdn>          : Add a serial console to a specific
                                machine (superusers only).
remotepower <fqdn>            : Add a remote power to a specific
                                machine (superusers only).
virtualmachine <architecture> : Add a virtual machine on a specific
                                architecture.

Example:
    ADD machine
    ADD virtualmachine x86_64
    ADD serialconsole foo.suse.de
    ADD remotepower foo.suse.de
    ADD annotation foo.suse.de
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
DELETE
.sp
Removes information from the database.
.sp
Command description:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(orthos 2.0.0) help delete
Deletes items from the database.

Usage:
    DELETE <item> [args*]

Arguments:
    item \- Specify the item which should be deleted. Items are:

machine       : Delete a machine (superusers only).
serialconsole : Delete serial console of a specifc machine
                (superusers only).
remotepower   : Delete remote power of a specifc machine
                (superusers only).

Example:
    DELETE machine
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
SERVERCONFIG
.sp
Show server configuration.
.sp
Command description:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(orthos 2.0.0) help serverconfig
Show server configuration (superusers only).

Usage:
    CONFIG

Example:
    CONFIG
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
RESCAN
.sp
Rescan a machine.
.sp
Command description:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(orthos 2.0.0) help rescan
Command to rescan machines. Normally all machines are scanned once a day automatically. For some reason it makes sense to rescan machines manually immediately, e.g. if new hardware has been added.

Usage:
    RESCAN <fqdn> <option>

Arguments:
    fqdn   \- FQDN or hostname of the machine.
    option \- Specify what should be rescanned. Options are:

status            : Check machine status (ping, SSH, login).
all               : Complete scan.
misc              : Check miscellaneous software/hardware attributes.
installations     : Rescan installed distributions only.
networkinterfaces : Rescan network interfaces only.

Example:
    RESCAN foo.suse.de networkinterfaces
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
RESERVE
.sp
Reserve machines.
.sp
Command description:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(orthos 2.0.0) help reserve
Reserves a machine.

Usage:
    RESERVE <fqdn>

Arguments:
    fqdn \- FQDN or hostname of the machine.

Example:
    RESERVE foo.suse.de
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
RESERVATIONHISTORY
.sp
Show reservation history of a machine.
.sp
Command description:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(orthos 2.0.0) help RESERVATIONHISTORY
Show reservation history of a machine.

Usage:
    RESERVATIONHISTORY <machine>

Arguments:
    machine \- FQDN or hostname of the machine.

Example:
    RESERVATIONHISTORY foo.suse.de
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
ALIAS
.sp
Define own aliases.
.sp
Command description:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(orthos 2.0.0) help alias
Define or display aliases. The command can be called without any arguments, then it displays all available aliases. If it\(aqs called with one argument, then it displays the definition of a specific alias. If it is called with more than two arguments, then you can define new aliases.

To execute an alias, type the alias name with a leading \(aq@\(aq.

Usage:
    ALIAS [alias] [*args]

Arguments:
    alias \- Alias name.
    *args \- Valid command string.

Example:
    ALIAS
    ALIAS allmachines query name, ipv4 where name =~ foobar
    ALIAS allmachines

@allmachines
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
AUTH
.sp
Request authorisation manually.
.sp
Command description:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(orthos 2.0.0) auth
Orthos password for \(aqyour_login_name\(aq:*******
(orthos 2.0.0)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
QUERY
.sp
Retrieve information about a machine.
.sp
Command description:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
(orthos 2.0.0) help query
Command to query machines. You can just specify a comma\-separated list of fields, then you get that fields for all machines.

Example:

QUERY fqdn, cpu_physical
QUERY fqdn WHERE cpu_model =~ Intel
QUERY fqdn WHERE cpu_model =~ Intel OR !efi

Valid operators are:
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
!<field>            not
== =                exactly equal
=~                  contains
=*                  startswith
!=                  unequal
>  <                greater or less than (numbers only)
>= <=               greater equals or less equals (numbers only)
AND                 logical conjunction
OR                  logical disjunction
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.ft P
.fi
.UNINDENT
.UNINDENT
.SH ORTHOS VARIABLES AND OBJECTS
.sp
The Orthos Client has many objects that you can query from the machine objects in Orthos. The names are always
self\-explanatory and can be used for queries as described above under the QUERY command.
.INDENT 0.0
.IP \(bu 2
A: active, administrative, annotation_created, annotation_reporter, annotation_text, architecture
.IP \(bu 2
B: bios_version, bios_date
.IP \(bu 2
C: check_connectivity, collect_system_information, comment, contact_email, cpu_cores, cpu_flags, cpu_id,
cpu_model, cpu_physical, cpu_speed, cpu_threads, created
.IP \(bu 2
D: dhcp_filename, disk_primary_size, disk_type, dmesg, dmidecode, domain
.IP \(bu 2
E: efi, enclosure, enclosure_platform, enclosure_vendor
.IP \(bu 2
F: fqdn, fqdn_domain
.IP \(bu 2
G: group
.IP \(bu 2
H: hwinfo
.IP \(bu 2
I: id, iface_driver_module, iface_ethernet_type, iface_mac_address, iface_name, iface_primary, infinite, inst_active,
inst_arch, inst_dist, inst_kernel, inst_partition, ipmi, ipv4, ipv6
.IP \(bu 2
K: kernel_options
.IP \(bu 2
L: last, last_check, lsmod, lspci, lsscsi, lsusb
.IP \(bu 2
N: name
.IP \(bu 2
P: pci_classid, pci_classname, pci_device, pci_deviceid, pci_driver, pci_revision, pci_sdeviceid, pci_sdevicename,
pci_slot, pci_svendorid, pci_svendorname, pci_vendor, pci_vendorid, platform, product_code
.IP \(bu 2
R: ram, ram_amount, res_by, reserved_at, reserved_by, reserved_by_email, reserved_reason, reserved_until, rpower,
rpower_device, rpower_management_bmc, rpower_port, rpower_power_device, rpower_type
.IP \(bu 2
S: sconsole, serial_baud, serial_command, serial_comment, serial_console_server, serial_cscreen_server, serial_device,
serial_kernel_device, serial_management_bmc, serial_number, serial_port, serial_type, status_abuild, status_ipv4,
status_ipv6, status_login, status_ping, status_ssh, system
.IP \(bu 2
U: updated
.IP \(bu 2
V: virtualization_api, vm_auto_delete, vm_capable, vm_dedicated_host, vm_max
.UNINDENT
.SH AUTHOR
Thomas Renninger
.SH COPYRIGHT
2020, openSUSE Orthos2 Team
.\" Generated by docutils manpage writer.
.

Places

File orthos2.1 of Package orthos-client (Revision 57d66b516459596d3839f24cea9c5644)

Places