stopInstance (OCI)

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 CodeFDOCI_CLOUD_ACCOUNT_CODEN1OCI account with all the required properties like Tenancy Id, User OCID, Private Key, etc.
OCI RegionFDOCI_REGIONN1OCI 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 FingerprintFDOCIACCT_KEY_FINGERPRINTYThe fingerprint of the key being used for authentication
OCI Private KeyFDOCIACCT_PRIVATE_KEY_PATHYThe private key to use for authentication
OCI Private Key PassphraseFDOCIACCT_KEY_PASSPHRASENA 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 OCIDFDOCIACCT_USER_OCIDY

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 AccountFDOCI_INP_CLOUD_ACCOUNT_CODEN2OCI account with all the required properties like Tenancy Id, User OCID, Private Key, etc.
OCI RegionFDOCI_INP_REGIONN2OCI region where instances are managed (US_ASHBURN_1, EU_FRANKFURT_1, UK_LONDON_1, US_PHOENIX_1)
OCI Compartment NameFDOCI_COMPARTMENT_NAMENOCI compartment where instances are managed. Leave blank for root compartment. For example, Sandbox
OCI Instance NameFDOCI_INSTANCE_NAMEYOCI 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.


The following macros are not currently supported in the footer:
  • style