oracle.oci.oci_data_science_notebook_session – Manage a NotebookSession resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a NotebookSession resource in Oracle Cloud Infrastructure
For state=present, creates a new notebook session.
This resource has the following action operations in the oracle.oci.oci_data_science_notebook_session_actions module: activate, change_compartment, deactivate.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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 where you want to create the notebook session.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
||||
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 . |
||||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
|
||||
display_name
string
|
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`
Required for create, update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
||||
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
|||
freeform_tags
dictionary
|
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"}`
This parameter is updatable.
|
||||
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
||||
notebook_session_config_details
dictionary
|
|||||
block_storage_size_in_gbs
integer
|
A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.
|
||||
notebook_session_shape_config_details
dictionary
|
|||||
memory_in_gbs
float
|
The total amount of memory available to the notebook session instance, in gigabytes.
|
||||
ocpus
float
|
The total number of OCPUs available to the notebook session instance.
|
||||
shape
string
/ required
|
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.
|
||||
subnet_id
string
|
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.
|
||||
notebook_session_configuration_details
dictionary
|
This parameter is updatable.
|
||||
block_storage_size_in_gbs
integer
|
A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs.
|
||||
notebook_session_shape_config_details
dictionary
|
|||||
memory_in_gbs
float
|
The total amount of memory available to the notebook session instance, in gigabytes.
|
||||
ocpus
float
|
The total number of OCPUs available to the notebook session instance.
|
||||
shape
string
/ required
|
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.
|
||||
subnet_id
string
/ required
|
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.
|
||||
notebook_session_id
string
|
The OCID of the notebook session.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
||||
notebook_session_runtime_config_details
dictionary
|
This parameter is updatable.
|
||||
custom_environment_variables
dictionary
|
Custom environment variables for Notebook Session. These key-value pairs will be available for customers in Notebook Sessions.
|
||||
notebook_session_git_config_details
dictionary
|
|||||
notebook_session_git_repo_config_collection
list
/ elements=dictionary
|
A collection of Git repository configurations.
|
||||
url
string
/ required
|
The repository URL
|
||||
project_id
string
|
The OCID of the project to associate with the notebook session.
Required for create using state=present.
|
||||
realm_specific_endpoint_template_enabled
boolean
|
|
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. |
||||
state
string
|
|
The state of the NotebookSession.
Use state=present to create or update a NotebookSession.
Use state=absent to delete a NotebookSession.
|
|||
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
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create notebook_session
oci_data_science_notebook_session:
# required
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
notebook_session_config_details:
# required
shape: shape_example
# optional
block_storage_size_in_gbs: 56
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
notebook_session_shape_config_details:
# optional
ocpus: 3.4
memory_in_gbs: 3.4
display_name: display_name_example
notebook_session_configuration_details:
# required
shape: shape_example
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
# optional
block_storage_size_in_gbs: 56
notebook_session_shape_config_details:
# optional
ocpus: 3.4
memory_in_gbs: 3.4
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
notebook_session_runtime_config_details:
# optional
custom_environment_variables: null
notebook_session_git_config_details:
# optional
notebook_session_git_repo_config_collection:
- # required
url: url_example
- name: Update notebook_session
oci_data_science_notebook_session:
# required
notebook_session_id: "ocid1.notebooksession.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
notebook_session_configuration_details:
# required
shape: shape_example
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
# optional
block_storage_size_in_gbs: 56
notebook_session_shape_config_details:
# optional
ocpus: 3.4
memory_in_gbs: 3.4
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
notebook_session_runtime_config_details:
# optional
custom_environment_variables: null
notebook_session_git_config_details:
# optional
notebook_session_git_repo_config_collection:
- # required
url: url_example
- name: Update notebook_session using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_data_science_notebook_session:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
notebook_session_configuration_details:
# required
shape: shape_example
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
# optional
block_storage_size_in_gbs: 56
notebook_session_shape_config_details:
# optional
ocpus: 3.4
memory_in_gbs: 3.4
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
notebook_session_runtime_config_details:
# optional
custom_environment_variables: null
notebook_session_git_config_details:
# optional
notebook_session_git_repo_config_collection:
- # required
url: url_example
- name: Delete notebook_session
oci_data_science_notebook_session:
# required
notebook_session_id: "ocid1.notebooksession.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete notebook_session using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_data_science_notebook_session:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||||
---|---|---|---|---|---|---|
notebook_session
complex
|
on success |
Details of the NotebookSession resource acted upon by the current operation
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.
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 |
|
||||
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)