stopInstance (OCI)

Stops an OCI instance that is running

Target Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

OCI Account Code

FDOCI_CLOUD_ACCOUNT_CODE

No

OCI account with all the required properties like Tenancy Id, User OCID, Private Key, etc.

OCI Region

FDOCI_REGION

No

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 a Target property or by the corresponding plugin input. If both are defined, input will take precedence.

Cloud Account Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

OCI Tenancy Id

FDOCIACCT_TENANCY_ID

Yes

The tenancy Id of the Oracle Cloud account used to connect

OCI User OCID

FDOCIACCT_USER_OCID

Yes

The OCID of the user used to connect to Oracle Cloud

OCI Private Key

FDOCIACCT_PRIVATE_KEY_PATH

Yes

The private key to use for authentication

OCI Key Fingerprint

FDOCIACCT_KEY_FINGERPRINT

Yes

The fingerprint of the key being used for authentication

OCI Private Key Passphrase

FDOCIACCT_KEY_PASSPHRASE

No

A passphrase for the private key if required

Inputs

Input Name

Input Code

Required

Description

Input Name

Input Code

Required

Description

OCI Account

FDOCI_INP_CLOUD_ACCOUNT_CODE

No

OCI account with all the required properties like Tenancy Id, User OCID, Private Key, etc.

OCI Region

FDOCI_INP_REGION

No

OCI region where instances are managed (US_ASHBURN_1, EU_FRANKFURT_1, UK_LONDON_1, US_PHOENIX_1)

OCI Compartment Name

FDOCI_COMPARTMENT_NAME

No

OCI compartment where instances are managed. Leave blank for root compartment. For example, Sandbox

OCI Instance Name

FDOCI_INSTANCE_NAME

Yes

OCI instance name. For example, soaoci01

2 - Input must be defined either by a plugin input or by the corresponding Target property. If both are defined, input will take precedence.

Artifacts

This operation doesn’t consume or produce any artifacts.

Endpoint Selection

This operation will select all available endpoints associated to the Target.

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