oracle.oci.oci_container_instances_container_instance_actions – Perform actions on a ContainerInstance resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_container_instances_container_instance_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a ContainerInstance resource in Oracle Cloud Infrastructure

  • For action=change_compartment, moves a container instance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

  • For action=restart, restarts a container instance. When provided, If-Match is checked against ETag values of the container instance.

  • For action=start, starts a container instance if it is “inactive”. No effect otherwise. When provided, If-Match is checked against ETag values of the container instance.

  • For action=stop, stops a container instance if it is “active”. No effect otherwise. When provided, If-Match is checked against ETag values of the container instance.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • change_compartment
  • restart
  • start
  • stop
The action to perform on the ContainerInstance.
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The OCID of the compartment to move the container instance to.
Required for action=change_compartment.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
container_instance_id
string / required
The OCID of the container instance.

aliases: id
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Perform action change_compartment on container_instance
  oci_container_instances_container_instance_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    container_instance_id: "ocid1.containerinstance.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

- name: Perform action restart on container_instance
  oci_container_instances_container_instance_actions:
    # required
    container_instance_id: "ocid1.containerinstance.oc1..xxxxxxEXAMPLExxxxxx"
    action: restart

- name: Perform action start on container_instance
  oci_container_instances_container_instance_actions:
    # required
    container_instance_id: "ocid1.containerinstance.oc1..xxxxxxEXAMPLExxxxxx"
    action: start

- name: Perform action stop on container_instance
  oci_container_instances_container_instance_actions:
    # required
    container_instance_id: "ocid1.containerinstance.oc1..xxxxxxEXAMPLExxxxxx"
    action: stop

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
container_instance
complex
on success
Details of the ContainerInstance resource acted upon by the current operation

Sample:
{'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'container_count': 56, 'container_restart_policy': 'ALWAYS', 'containers': [{'container_id': 'ocid1.container.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example'}], 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'dns_config': {'nameservers': [], 'options': [], 'searches': []}, 'fault_domain': 'FAULT-DOMAIN-1', 'freeform_tags': {'Department': 'Finance'}, 'graceful_shutdown_timeout_in_seconds': 56, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'image_pull_secrets': [{'registry_endpoint': 'registry_endpoint_example', 'secret_id': 'ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx', 'secret_type': 'BASIC'}], 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'shape': 'shape_example', 'shape_config': {'memory_in_gbs': 3.4, 'networking_bandwidth_in_gbps': 3.4, 'ocpus': 3.4, 'processor_description': 'processor_description_example'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'vnics': [{'vnic_id': 'ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx'}], 'volume_count': 56, 'volumes': [{'backing_store': 'EPHEMERAL_STORAGE', 'configs': [{'data': None, 'file_name': 'file_name_example', 'path': 'path_example'}], 'name': 'name_example', 'volume_type': 'EMPTYDIR'}]}
 
availability_domain
string
on success
The availability domain to place the container instance.

Sample:
Uocm:PHX-AD-1
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
container_count
integer
on success
The number of containers on the container instance.

Sample:
56
 
container_restart_policy
string
on success
The container restart policy is applied for all containers in container instance.

Sample:
ALWAYS
 
containers
complex
on success
The containers on the container instance.
   
container_id
string
on success
The OCID of the container.

Sample:
ocid1.container.oc1..xxxxxxEXAMPLExxxxxx
   
display_name
string
on success
Display name for the Container.

Sample:
display_name_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`.

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
dns_config
complex
on success

   
nameservers
list / elements=string
on success
IP address of the name server..
   
options
list / elements=string
on success
Options allows certain internal resolver variables to be modified.
   
searches
list / elements=string
on success
Search list for hostname lookup.
 
fault_domain
string
on success
The fault domain to place the container instance.

Sample:
FAULT-DOMAIN-1
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
graceful_shutdown_timeout_in_seconds
integer
on success
The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.

Sample:
56
 
id
string
on success
An OCID that cannot be changed.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
image_pull_secrets
complex
on success
The image pulls secrets so you can access private registry to pull container images.
   
registry_endpoint
string
on success
The registry endpoint of the container image.

Sample:
registry_endpoint_example
   
secret_id
string
on success
The OCID of the secret for registry credentials.

Sample:
ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx
   
secret_type
string
on success
The type of ImagePullSecret.

Sample:
BASIC
 
lifecycle_details
string
on success
A message that describes the current state of the container in more detail. Can be used to provide actionable information.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the container instance.

Sample:
CREATING
 
shape
string
on success
The shape of the container instance. The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance.

Sample:
shape_example
 
shape_config
complex
on success

   
memory_in_gbs
float
on success
The total amount of memory available to the container instance, in gigabytes.

Sample:
3.4
   
networking_bandwidth_in_gbps
float
on success
The networking bandwidth available to the container instance, in gigabits per second.

Sample:
3.4
   
ocpus
float
on success
The total number of OCPUs available to the container instance.

Sample:
3.4
   
processor_description
string
on success
A short description of the container instance's processor (CPU).

Sample:
processor_description_example
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`.
 
time_created
string
on success
The time the container instance was created, in the format defined by RFC 3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the container instance was updated, in the format defined by RFC 3339.

Sample:
2013-10-20T19:20:30+01:00
 
vnics
complex
on success
The virtual networks available to the containers in the container instance.
   
vnic_id
string
on success
The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network.

Sample:
ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx
 
volume_count
integer
on success
The number of volumes that are attached to the container instance.

Sample:
56
 
volumes
complex
on success
A volume is a directory with data that is accessible across multiple containers in a container instance.
   
backing_store
string
on success
The volume type of the empty directory, can be either File Storage or Memory.

Sample:
EPHEMERAL_STORAGE
   
configs
complex
on success
Contains string key value pairs which can be mounted as individual files inside the container. The value needs to be base64 encoded. It is decoded to plain text before the mount.
     
data
string
on success
The base64 encoded contents of the file. The contents are decoded to plain text before mounted as a file to a container inside container instance.

Sample:
null
     
file_name
string
on success
The name of the file. The fileName should be unique across the volume.

Sample:
file_name_example
     
path
string
on success
(Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.

Sample:
path_example
   
name
string
on success
The name of the volume. This must be unique within a single container instance.

Sample:
name_example
   
volume_type
string
on success
The type of volume.

Sample:
EMPTYDIR


Authors

  • Oracle (@oracle)