Class: Ansible::Ruby::Modules::Gcp_compute_image

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Gcp_compute_image

Defined in:

lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_image.rb

Overview

Represents an Image resource. Google Compute Engine uses operating system images to create the root persistent disks for your instances. You specify an image when you create an instance. Images contain a boot loader, an operating system, and a root file system. Linux operating system images are also capable of running containers on Compute Engine. Images can be either public or custom. Public images are provided and maintained by Google, open-source communities, and third-party vendors. By default, all projects have access to these images and can use them to create instances. Custom images are available only to your project. You can create a custom image from root persistent disks and other images. Then, use the custom image to create an instance.

Instance Method Summary

• #description ⇒ Object^?

  An optional description of this resource.

• #disk_size_gb ⇒ Object^?

  Size of the image when restored onto a persistent disk (in GB).

• #family ⇒ Object^?

  The name of the image family to which this image belongs.

• #guest_os_features ⇒ Object^?

  A list of features to enable on the guest OS.

• #image_encryption_key ⇒ Object^?

  Encrypts the image using a customer-supplied encryption key.,After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image) .

• #licenses ⇒ Object^?

  Any applicable license URI.

• #name ⇒ String

  Name of the resource; provided by the client when the resource is created.

• #raw_disk ⇒ Object^?

  The parameters of the raw disk image.

• #source_disk ⇒ String^?

  Refers to a gcompute_disk object You must provide either this property or the rawDisk.source property but not both to create an image.

• #source_disk_encryption_key ⇒ Object^?

  The customer-supplied encryption key of the source disk.

• #source_disk_id ⇒ Object^?

  The ID value of the disk used to create this image.

• #source_type ⇒ :RAW^?

  The type of the image used to create this disk.

• #state ⇒ :present, ...

  Whether the given object should exist in GCP.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#description ⇒ Object^?

Returns An optional description of this resource. Provide this property when you create the resource.

Returns:

• (Object, nil) —

  An optional description of this resource. Provide this property when you create the resource.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_image.rb', line 19

attribute :description

#disk_size_gb ⇒ Object^?

Returns Size of the image when restored onto a persistent disk (in GB).

Returns:

• (Object, nil) —

  Size of the image when restored onto a persistent disk (in GB).

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_image.rb', line 22

attribute :disk_size_gb

#family ⇒ Object^?

Returns The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

Returns:

• (Object, nil) —

  The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_image.rb', line 25

attribute :family

#guest_os_features ⇒ Object^?

Returns A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE.,For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image.,This value is purely informational and does not enable or disable any features.

Returns:

• (Object, nil) —

  A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE.,For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image.,This value is purely informational and does not enable or disable any features.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_image.rb', line 28

attribute :guest_os_features

#image_encryption_key ⇒ Object^?

Returns Encrypts the image using a customer-supplied encryption key.,After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image) .

Returns:

• (Object, nil) —

  Encrypts the image using a customer-supplied encryption key.,After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image) .

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_image.rb', line 31

attribute :image_encryption_key

#licenses ⇒ Object^?

Returns Any applicable license URI.

Returns:

• (Object, nil) —

  Any applicable license URI.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_image.rb', line 34

attribute :licenses

#name ⇒ String

Returns Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression ‘[a-z](*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns:

• (String) —

  Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression ‘[a-z](*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_image.rb', line 37

attribute :name

#raw_disk ⇒ Object^?

Returns The parameters of the raw disk image.

Returns:

• (Object, nil) —

  The parameters of the raw disk image.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_image.rb', line 41

attribute :raw_disk

#source_disk ⇒ String^?

Returns Refers to a gcompute_disk object You must provide either this property or the rawDisk.source property but not both to create an image.

Returns:

• (String, nil) —

  Refers to a gcompute_disk object You must provide either this property or the rawDisk.source property but not both to create an image.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_image.rb', line 44

attribute :source_disk

#source_disk_encryption_key ⇒ Object^?

Returns The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

Returns:

• (Object, nil) —

  The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_image.rb', line 48

attribute :source_disk_encryption_key

#source_disk_id ⇒ Object^?

Returns The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.

Returns:

• (Object, nil) —

  The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_image.rb', line 51

attribute :source_disk_id

#source_type ⇒ :RAW^?

Returns The type of the image used to create this disk. The default and only value is RAW .

Returns:

• (:RAW, nil) —

  The type of the image used to create this disk. The default and only value is RAW .

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_image.rb', line 54

attribute :source_type

#state ⇒ :present, ...

Returns Whether the given object should exist in GCP.

Returns:

• (:present, :absent, nil) —

  Whether the given object should exist in GCP

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_image.rb', line 15

attribute :state