stopInstance (OCI)
- Ben Hoffman
- Emily Simon
- Dan Reynebeau
Stops an OCI instance that is running
@Since 5.1.0.2 OCI Tenancy Id, OCI User OCID, OCI Private Key, OCI Key Fingerprint, and OCI Private Key Passphrase are defined by the configured OCI Account Code property. Both OCI Account Code and OCI Region must be defined as either a plugin input or environment/instance property.
Environment/Instance Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
| OCI Account Code | FDOCI_CLOUD_ACCOUNT_CODE | N1 | OCI account with all the required properties like Tenancy Id, User OCID, Private Key, etc. |
| OCI Region | FDOCI_REGION | N1 | OCI region where instances are managed (US_ASHBURN_1, EU_FRANKFURT_1, UK_LONDON_1, US_PHOENIX_1) |
1 - Property must be defined either by an environment/instance property or by the corresponding plugin input. If both are defined, input will take precedence.
Cloud Account Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
| OCI Key Fingerprint | FDOCIACCT_KEY_FINGERPRINT | Y | The fingerprint of the key being used for authentication |
| OCI Private Key | FDOCIACCT_PRIVATE_KEY_PATH | Y | The private key to use for authentication |
| OCI Private Key Passphrase | FDOCIACCT_KEY_PASSPHRASE | N | A passphrase for the private key if required |
OCI Tenancy Id | FDOCIACCT_TENANCY_ID | Y | The tenancy Id of the Oracle Cloud account used to connect |
| OCI User OCID | FDOCIACCT_USER_OCID | Y | The OCID of the user used to connect to Oracle Cloud |
Project Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
Inputs
Input Name | Input Code | Required | Description |
|---|---|---|---|
| OCI Account | FDOCI_INP_CLOUD_ACCOUNT_CODE | N2 | OCI account with all the required properties like Tenancy Id, User OCID, Private Key, etc. |
| OCI Region | FDOCI_INP_REGION | N2 | OCI region where instances are managed (US_ASHBURN_1, EU_FRANKFURT_1, UK_LONDON_1, US_PHOENIX_1) |
| OCI Compartment Name | FDOCI_COMPARTMENT_NAME | N | OCI compartment where instances are managed. Leave blank for root compartment. For example, Sandbox |
| OCI Instance Name | FDOCI_INSTANCE_NAME | Y | OCI instance name. For example, soaoci01 |
2 - Input must be defined either by a plugin input or by the corresponding environment/instance property. If both are defined, input will take precedence.
Outputs
Output Name | Required | Description |
|---|---|---|
Artifacts
This operation doesn’t consume or produce any artifacts.
Endpoint Selection
This operation will select all available endpoints associated to the environment/instance.
Endpoint Execution
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
Special Considerations
Java 8 is required for this plugin operation.
- style