% INSTANCE(1) Version 1.0.0 | Scripts Documentation
% Georg Voell - georg.voell@oracle.com
% (c)2020 Oracle

NAME
====

**instance** - (BASH Script) Do some jobs with instances

SYNOPSIS
========

| **instance** \[_options_] \[_action_] 

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

Do some jobs with instances

Options
-------

 -h, --help                 : Displays helptext.

-v, \--version                      

:  Displays the version of the script.

-i, \--instance-id _ocid_           

:  Instance OCID.

-c, \--compartment-id _ocid_        

:  Compartment OCID.

-v, \--vnic-id _ocid_               

:  VNIC (Virtual Network Interface Card) OCID.

Action
-------

status        

:  List only lifecycle-state of instance specified with instance-id.

list          

:  List all instances or one instance specified with instance-id.

stop          

:  Stop instance specified with instance-id.

start         

:  Start instance specified with instance-id.

open          

:  Attach reserved public ip and allow access for ssh.

close         

:  Detach reserved public ip and deny access for ssh.


EXAMPLES
========

**instance**

: List compartments and all instances running in these compartments.

**instance** list \--compartment-id ocid1.tenancy.oc1..xxxxxxxxx

: List all instances in root compartment.

**instance** stop \--**instance**-id ocid1.**instance**.oc1.xxxxxxxxx

: Stop instance specifies with instance-id.


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

01: Unknown or wrong parameter.

02: Unknown action.

03: No **instance-id** specified with start or stop.

04: Instance was already running or stopped.

05: Instance was already opened or closed.

06: Could not attach / detach public ip (or unexpected error)

99: User interrupt.


SEE ALSO
========

**install-scripts**(1)