oracle.oci.oci_data_integration_workspace_actions – Perform actions on a Workspace resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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_data_integration_workspace_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a Workspace resource in Oracle Cloud Infrastructure

  • For action=change_compartment, moves a workspace to a specified compartment.

  • For action=start, starts a workspace.

  • For action=stop, stops a workspace.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • change_compartment
  • start
  • stop
The action to perform on the Workspace.
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
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 the workspace 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.
is_force_operation
boolean
    Choices:
  • no
  • yes
Used to force close down the workspace.
Applicable only for action=stop.
quiesce_timeout
integer
Used to set the timeout for Data Integration to gracefully close down any running jobs before stopping the workspace.
Applicable only for action=stop.
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.
workspace_id
string / required
The workspace ID.

aliases: id

Examples

- name: Perform action change_compartment on workspace
  oci_data_integration_workspace_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    workspace_id: "ocid1.workspace.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

- name: Perform action start on workspace
  oci_data_integration_workspace_actions:
    # required
    workspace_id: "ocid1.workspace.oc1..xxxxxxEXAMPLExxxxxx"
    action: start

- name: Perform action stop on workspace
  oci_data_integration_workspace_actions:
    # required
    workspace_id: "ocid1.workspace.oc1..xxxxxxEXAMPLExxxxxx"
    action: stop

    # optional
    quiesce_timeout: 0
    is_force_operation: true

Return Values

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

Key Returned Description
workspace
complex
on success
Details of the Workspace resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'dns_server_ip': 'dns_server_ip_example', 'dns_server_zone': 'dns_server_zone_example', 'endpoint_id': 'ocid1.endpoint.oc1..xxxxxxEXAMPLExxxxxx', 'endpoint_name': 'endpoint_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_private_network_enabled': True, 'lifecycle_state': 'CREATING', 'registry_id': 'ocid1.registry.oc1..xxxxxxEXAMPLExxxxxx', 'state_message': 'state_message_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx'}
 
compartment_id
string
on success
The OCID of the compartment containing the workspace.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
A detailed description for the workspace.

Sample:
description_example
 
display_name
string
on success
A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.

Sample:
display_name_example
 
dns_server_ip
string
on success
The IP of the custom DNS.

Sample:
dns_server_ip_example
 
dns_server_zone
string
on success
The DNS zone of the custom DNS to use to resolve names.

Sample:
dns_server_zone_example
 
endpoint_id
string
on success
OCID of the private endpoint associated with the container/workspace.

Sample:
ocid1.endpoint.oc1..xxxxxxEXAMPLExxxxxx
 
endpoint_name
string
on success
Name of the private endpoint associated with the container/workspace.

Sample:
endpoint_name_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
A system-generated and immutable identifier assigned to the workspace upon creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_private_network_enabled
boolean
on success
Specifies whether the private network connection is enabled or disabled.

Sample:
True
 
lifecycle_state
string
on success
Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.

Sample:
CREATING
 
registry_id
string
on success
DCMS Registry ID associated with the container/workspace.

Sample:
ocid1.registry.oc1..xxxxxxEXAMPLExxxxxx
 
state_message
string
on success
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.

Sample:
state_message_example
 
subnet_id
string
on success
The OCID of the subnet for customer connected databases.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time the workspace was created, in the timestamp format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the workspace was updated, in the timestamp format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
vcn_id
string
on success
The OCID of the VCN the subnet is in.

Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)