oracle.oci.oci_data_science_notebook_session_facts – Fetches details about one or multiple NotebookSession resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple NotebookSession resources in Oracle Cloud Infrastructure

  • Lists the notebook sessions in the specified compartment.

  • If notebook_session_id is specified, the details of a single NotebookSession will be returned.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
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
<b>Filter</b> results by the OCID of the compartment.
Required to list multiple notebook_sessions.
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.
created_by
string
<b>Filter</b> results by the OCID of the user who created the resource.
display_name
string
<b>Filter</b> results by its user-friendly name.

aliases: name
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
  • INACTIVE
  • UPDATING
<b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.
notebook_session_id
string
The OCID of the notebook session.
Required to get a specific notebook_session.

aliases: id
project_id
string
<b>Filter</b> results by the OCID of the project.
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.
sort_by
string
    Choices:
  • timeCreated
  • displayName
Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. When you sort by `displayName`, results are shown in ascending order. Sort order for the `displayName` field is case sensitive.
sort_order
string
    Choices:
  • ASC
  • DESC
Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).
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

Examples

- name: Get a specific notebook_session
  oci_data_science_notebook_session_facts:
    # required
    notebook_session_id: "ocid1.notebooksession.oc1..xxxxxxEXAMPLExxxxxx"

- name: List notebook_sessions
  oci_data_science_notebook_session_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    lifecycle_state: CREATING
    created_by: created_by_example
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
notebook_sessions
complex
on success
List of NotebookSession resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_by': 'created_by_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'notebook_session_config_details': {'block_storage_size_in_gbs': 56, 'notebook_session_shape_config_details': {'memory_in_gbs': 3.4, 'ocpus': 3.4}, 'shape': 'shape_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx'}, 'notebook_session_configuration_details': {'block_storage_size_in_gbs': 56, 'notebook_session_shape_config_details': {'memory_in_gbs': 3.4, 'ocpus': 3.4}, 'shape': 'shape_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx'}, 'notebook_session_runtime_config_details': {'custom_environment_variables': {}, 'notebook_session_git_config_details': {'notebook_session_git_repo_config_collection': [{'url': 'url_example'}]}}, 'notebook_session_url': 'notebook_session_url_example', 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00'}]
 
compartment_id
string
on success
The OCID of the notebook session's compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
created_by
string
on success
The OCID of the user who created the notebook session.

Sample:
created_by_example
 
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'}}
 
display_name
string
on success
A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: `My NotebookSession`

Sample:
display_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
The OCID of the notebook session.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
Details about the state of the notebook session.
Returned for get operation

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The state of the notebook session.

Sample:
CREATING
 
notebook_session_config_details
complex
on success

   
block_storage_size_in_gbs
integer
on success
A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

Sample:
56
   
notebook_session_shape_config_details
complex
on success

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

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

Sample:
3.4
   
shape
string
on success
The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the `ListNotebookSessionShapes` endpoint.

Sample:
shape_example
   
subnet_id
string
on success
A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
notebook_session_configuration_details
complex
on success

   
block_storage_size_in_gbs
integer
on success
A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.

Sample:
56
   
notebook_session_shape_config_details
complex
on success

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

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

Sample:
3.4
   
shape
string
on success
The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the `ListNotebookSessionShapes` endpoint.

Sample:
shape_example
   
subnet_id
string
on success
A notebook session instance is provided with a VNIC for network access. This specifies the OCID of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
notebook_session_runtime_config_details
complex
on success
Returned for get operation

   
custom_environment_variables
dictionary
on success
Custom environment variables for Notebook Session. These key-value pairs will be available for customers in Notebook Sessions.

   
notebook_session_git_config_details
complex
on success

     
notebook_session_git_repo_config_collection
complex
on success
A collection of Git repository configurations.

       
url
string
on success
The repository URL

Sample:
url_example
 
notebook_session_url
string
on success
The URL to interact with the notebook session.

Sample:
notebook_session_url_example
 
project_id
string
on success
The OCID of the project associated with the notebook session.

Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)