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

NAME
====

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

SYNOPSIS
========

| **oci-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.

-r, \--region _regionstr_           

:  Region (e.g. eu-frankfurt-1).

-t, \--type _typestr_               

:  Instance type (e.g. instance or "instance,dbsystem").

-n, \--vnic-id _ocid_               

:  UNUSED - VNIC (Virtual Network Interface Card) OCID.

Action
-------

analyze
-------

 Not yet implemented (Search for Compartments that are not accessible and for Instances that are not in .ssh/config.

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.

TypeSTR (one type or list of types ins a comma separated string)
-------

instance        

:  List only IaaS Instances.

dbsystem        

:  List only DB Systems


EXAMPLES
========

**oci-instance**

: List compartments and all instances running in these compartments.

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

: List all instances in root compartment.

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

: Stop instance specifies with instance-id.


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

01: Unknown or wrong parameter.

02: Unknown action or action not allowed.

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)

96: Specified region not subscribed.

97: Tools not configured.

98: Unknown function call.

99: User interrupt.


SEE ALSO
========

**install-scripts**(1)