google.cloud.gcp_colab_runtime_template_info module – List Colab.RuntimeTemplate 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_runtime_template_info.

Synopsis

  • ‘A runtime template is a VM configuration that specifies a machine type and other characteristics of the VM,

  • as well as common settings such as the network and whether public internet access is enabled. When you create

  • a runtime, its VM is created according to the specifications of a runtime template.’

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

Examples

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

- name: List gcp_colab_runtime_template_info resources matching given filters
  google.cloud.gcp_colab_runtime_template_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.RuntimeTemplate resources matching the supplied filters. May be empty, contain a single resource, or multiple resources.

Returned: always

dataPersistentDiskSpec

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

description

string

The description of the Runtime Template.

Returned: when set

displayName

string

The display name of the Runtime Template.

Returned: always

encryptionSpec

dictionary

Customer-managed encryption key spec for the notebook runtime.

Returned: when set

kmsKeyName

string

The Cloud KMS encryption key (customer-managed encryption key) used to protect the runtime.

Returned: when set

eucConfig

dictionary

EUC configuration of the NotebookRuntimeTemplate.

Returned: when set

eucDisabled

boolean

Disable end user credential access for the runtime.

Returned: when set

idleShutdownConfig

dictionary

Notebook Idle Shutdown configuration for the runtime.

Returned: when set

idleTimeout

string

The duration after which the runtime is automatically shut down.

An input of 0s disables the idle shutdown feature, and a valid range is [10m, 24h].

Returned: when set

labels

dictionary

Labels to identify and group the runtime template.

**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.

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

name

string

The resource name of the Runtime Template.

Returned: always

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

networkTags

list / elements=string

Applies the given Compute Engine tags to the runtime.

Returned: when set

shieldedVmConfig

dictionary

Runtime Shielded VM spec.

Returned: when set

enableSecureBoot

boolean

Enables secure boot for the runtime.

Returned: when set

softwareConfig

dictionary

The notebook software configuration of the notebook runtime.

Returned: when set

colabImage

dictionary

Colab Image Configuration.

Returned: when set

releaseName

string

The release name of the NotebookRuntime Colab image, e.g.

“py310”.

If not specified, detault to the latest release.

Returned: when set

env

list / elements=dictionary

Environment variables to be passed to the container.

Returned: when set

name

string

Name of the environment variable.

Must be a valid C identifier.

Returned: when set

value

string

Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables.

If a variable cannot be resolved, the reference in the input string will be unchanged.

The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME).

Escaped references will never be expanded, regardless of whether the variable exists or not.

Returned: when set

postStartupScriptConfig

dictionary

Post startup script config.

Returned: when set

postStartupScript

string

Post startup script to run after runtime is started.

Returned: when set

postStartupScriptBehavior

string

Post startup script behavior that defines download and execution behavior.

Returned: when set

postStartupScriptUrl

string

Post startup script url to download.

Example: https://bucket/script.sh.

Returned: when set

Authors

  • Google Inc. (@googlecloudplatform)