% GET-PLATFORM(1) Version 3.1.0 | Scripts Documentation
% Georg Voell - georg.voell@standby.cloud
% (c)2023 Standby.cloud

NAME
====

**get-platform** - (BASH Script) Get some infos about the platform (OS) and machine.

SYNOPSIS
========

| **get-platform** \[_options_] \[_key_] 

DESCRIPTION
===========

Get some infos about the platform (OS) and machine.

Options
-------

-h, \--help                   

:  Displays helptext.

-v, \--version                

:  Displays the version of the script.

-o, \--output _string_        

:  Output format: _string_ can be "plain", "keys" or "json".

Key
-------

 This script can be called with an optional parameter "key" (otherwise it prints out all keys) e.g:

os        

:  Displays the Operation System e.g. "Linux", "Darwin", "SunOS".

id        

:  Displays the id e.g. "ol", "FreeBSD"


EXAMPLES
========

pname=`**get-platform** pretty_name`

: echo $pname # will display "Oracle Linux Server 7.4" on ol 7.4


EXIT CODES
==========

01: Unknown or wrong parameter.


SEE ALSO
========

**get-ip**(1), **check-port**(1), **install-scripts**(1)