google.cloud.gcp_colab_notebook_execution_info module – List Colab.NotebookExecution resources

Note

This module is part of the google.cloud collection (version 1.15.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 google.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: google.cloud.gcp_colab_notebook_execution_info.

Synopsis

• ‘An instance of a notebook Execution’

Requirements

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

• python >= 3.8

• requests >= 2.18.4

• google-auth >= 2.25.1

Parameters

Parameter	Comments
access_token string	The access token used to authenticate.
auth_kind string / required	The type of credential used. Choices: "accesstoken" "application" "machineaccount" "serviceaccount"
env_type string	Specifies which Ansible environment you’re running this module within. This should not be set unless you know what you’re doing. This only alters the User Agent string for any API requests.
filters list / elements=string	A list of filter expression strings used to filter the resources returned by the API. Each string is a filter expression (e.g. some_field = "SOME_VALUE"). Multiple expressions are combined with a logical AND. Refer to the filter topic documentation https://cloud.google.com/sdk/gcloud/reference/topic/filters. Refer to the AIP-160 filter syntax documentation https://google.aip.dev/160.
location string / required	The location for the resource: https://cloud.google.com/colab/docs/locations.
project string	The Google Cloud Platform project to use.
scopes list / elements=string	Array of scopes to be used.
service_account_contents jsonarg	The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
service_account_email string	An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file path	The path of a Service Account JSON file if serviceaccount is selected as type.

Notes

Note

• API Reference: https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.notebookExecutionJobs

• Schedule a notebook run Guide: https://cloud.google.com/colab/docs/schedule-notebook-run

• For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.

• For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE env variable.

• For authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.

• For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.

• For authentication, you can set access_token using the GCP_ACCESS_TOKEN env variable.

• For authentication, you can set scopes using the GCP_SCOPES env variable.

• Environment variables values will only be used if the playbook values are not set.

• The service_account_email, service_account_file, service_account_file and access_token options are mutually exclusive.

Examples

- name: List all gcp_colab_notebook_execution_info resources
  google.cloud.gcp_colab_notebook_execution_info:
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
  register: result

- name: List gcp_colab_notebook_execution_info resources matching given filters
  google.cloud.gcp_colab_notebook_execution_info:
    filters:
      - display_name = "my-resource"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
  register: result

Return Values

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

Key	Description
changed boolean	Whether any changes were made (always false for info modules). Returned: always
resources list / elements=dictionary	List of Colab.NotebookExecution resources matching the supplied filters. May be empty, contain a single resource, or multiple resources. Returned: always
customEnvironmentSpec dictionary	Compute configuration to use for an execution job. Returned: when set
machineSpec dictionary	‘The machine configuration of the runtime.’. Returned: when set
acceleratorCount integer	The number of accelerators used by the runtime. Returned: when set
acceleratorType string	The type of hardware accelerator used by the runtime. If specified, acceleratorCount must also be specified. Returned: when set
machineType string	The Compute Engine machine type selected for the runtime. Returned: when set
networkSpec dictionary	The network configuration for the runtime. Returned: when set
enableInternetAccess boolean	Enable public internet access for the runtime. Returned: when set
network string	The name of the VPC that this runtime is in. Returned: when set
subnetwork string	The name of the subnetwork that this runtime is in. Returned: when set
persistentDiskSpec dictionary	The configuration for the data disk of the runtime. Returned: when set
diskSizeGb string	The disk size of the runtime in GB. If specified, the diskType must also be specified. The minimum size is 10GB and the maximum is 65536GB. Returned: when set
diskType string	The type of the persistent disk. Returned: when set
shieldedInstanceConfig dictionary	Shielded VM configuration. Returned: when set
enableIntegrityMonitoring boolean	Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default. Returned: when set
enableSecureBoot boolean	Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default. Returned: when set
enableVtpm boolean	Defines whether the instance has the vTPM enabled. Enabled by default. Returned: when set
dataformRepositorySource dictionary	The Dataform Repository containing the input notebook. Returned: when set
commitSha string	The commit SHA to read repository with. If unset, the file will be read at HEAD. Returned: when set
dataformRepositoryResourceName string	The resource name of the Dataform Repository. Returned: always
directNotebookSource dictionary	The content of the input notebook in ipynb format. Returned: when set
content string	The base64-encoded contents of the input notebook file. Returned: always
displayName string	The display name of the Notebook Execution. Returned: always
executionTimeout string	Max running time of the execution job in seconds (default 86400s / 24 hrs). Returned: when set
executionUser string	The user email to run the execution as. Returned: when set
gcsNotebookSource dictionary	The Cloud Storage uri for the input notebook. Returned: when set
generation string	The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number. Returned: when set
uri string	The Cloud Storage uri pointing to the ipynb file. Returned: always
gcsOutputUri string	The Cloud Storage location to upload the result to. Format:`gs://bucket-name`. Returned: always
notebookRuntimeTemplateResourceName string	The NotebookRuntimeTemplate to source compute configuration from. Returned: when set
serviceAccount string	The service account to run the execution as. Returned: when set

Authors

• Google Inc. (@googlecloudplatform)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)