gcp_compute_instance_facts – Gather facts for GCP Instance¶
New in version 2.7.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
auth_kind
-
/ required
|
|
The type of credential used.
|
|
filters
-
|
A list of filter value pairs. Available filters are listed here https://cloud.google.com/sdk/gcloud/reference/topic/filters. Each additional filter in the list will act be added as an AND condition (filter1 and filter2)
|
|
|
project
-
|
Default: null
|
The Google Cloud Platform project to use.
|
|
scopes
-
|
Array of scopes to be used.
|
|
|
service_account_email
-
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
|
|
|
service_account_file
-
|
The path of a Service Account JSON file if serviceaccount is selected as type.
|
|
|
zone
-
/ required
|
A reference to the zone where the machine resides.
|
Notes¶
Note
- For authentication, you can set service_account_file using the
GCP_SERVICE_ACCOUNT_FILEenv variable. - For authentication, you can set service_account_email using the
GCP_SERVICE_ACCOUNT_EMAILenv variable. - For authentication, you can set auth_kind using the
GCP_AUTH_KINDenv variable. - For authentication, you can set scopes using the
GCP_SCOPESenv variable. - Environment variables values will only be used if the playbook values are not set.
- The service_account_email and service_account_file options are mutually exclusive.
Examples¶
- name: a instance facts
gcp_compute_instance_facts:
zone: us-central1-a
filters:
- name = test_object
project: test_project
auth_kind: service_account
service_account_file: "/tmp/auth.pem"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||||
|---|---|---|---|---|---|---|
|
items
complex
|
always |
List of items
|
||||
|
can_ip_forward
boolean
|
success |
Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes.
|
||||
|
cpu_platform
string
|
success |
The CPU platform used by this instance.
|
||||
|
creation_timestamp
string
|
success |
Creation timestamp in RFC3339 text format.
|
||||
|
disks
complex
|
success |
An array of disks that are associated with the instances that are created from this template.
|
||||
|
auto_delete
boolean
|
success |
Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
Tip: Disks should be set to autoDelete=true so that leftover disks are not left behind on machine deletion.
|
||||
|
boot
boolean
|
success |
Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
|
||||
|
device_name
string
|
success |
Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
|
||||
|
disk_encryption_key
complex
|
success |
Encrypts or decrypts a disk using a customer-supplied encryption key.
|
||||
|
raw_key
string
|
success |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
|
||||
|
rsa_encrypted_key
string
|
success |
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
|
||||
|
sha256
string
|
success |
The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
|
||||
|
index
integer
|
success |
Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
|
||||
|
initialize_params
complex
|
success |
Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
|
||||
|
disk_name
string
|
success |
Specifies the disk name. If not specified, the default is to use the name of the instance.
|
||||
|
disk_size_gb
integer
|
success |
Specifies the size of the disk in base-2 GB.
|
||||
|
disk_type
string
|
success |
Reference to a gcompute_disk_type resource.
Specifies the disk type to use to create the instance.
If not specified, the default is pd-standard.
|
||||
|
source_image
string
|
success |
The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required. To create a disk with one of the public operating system images, specify the image by its family name.
|
||||
|
source_image_encryption_key
complex
|
success |
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
|
||||
|
raw_key
string
|
success |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
|
||||
|
sha256
string
|
success |
The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
|
||||
|
interface
string
|
success |
Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.
Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI.
|
||||
|
mode
string
|
success |
The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
|
||||
|
source
dictionary
|
success |
Reference to a gcompute_disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required.
If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.
|
||||
|
type
string
|
success |
Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
|
||||
|
guest_accelerators
complex
|
success |
List of the type and count of accelerator cards attached to the instance .
|
||||
|
accelerator_count
integer
|
success |
The number of the guest accelerator cards exposed to this instance.
|
||||
|
accelerator_type
string
|
success |
Full or partial URL of the accelerator type resource to expose to this instance.
|
||||
|
id
integer
|
success |
The unique identifier for the resource. This identifier is defined by the server.
|
||||
|
label_fingerprint
string
|
success |
A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
|
||||
|
machine_type
string
|
success |
A reference to a machine type which defines VM kind.
|
||||
|
metadata
dictionary
|
success |
The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys.
|
||||
|
min_cpu_platform
string
|
success |
Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms .
|
||||
|
name
string
|
success |
The name of the resource, provided by the client when initially creating the resource. The resource 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]*[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.
|
||||
|
network_interfaces
complex
|
success |
An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one network interface is supported per instance.
|
||||
|
access_configs
complex
|
success |
An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
|
||||
|
name
string
|
success |
The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access.
|
||||
|
nat_ip
dictionary
|
success |
Specifies the title of a gcompute_address.
An external IP address associated with this instance.
Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
|
||||
|
type
string
|
success |
The type of configuration. The default and only option is ONE_TO_ONE_NAT.
|
||||
|
alias_ip_ranges
complex
|
success |
An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.
|
||||
|
ip_cidr_range
string
|
success |
The IP CIDR range represented by this alias IP range.
This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).
|
||||
|
subnetwork_range_name
string
|
success |
Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.
|
||||
|
name
string
|
success |
The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc .
|
||||
|
network
dictionary
|
success |
Specifies the title of an existing gcompute_network. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.
|
||||
|
network_ip
string
|
success |
An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
|
||||
|
subnetwork
dictionary
|
success |
Reference to a gcompute_subnetwork resource.
If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified.
|
||||
|
scheduling
complex
|
success |
Sets the scheduling options for this instance.
|
||||
|
automatic_restart
boolean
|
success |
Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
|
||||
|
on_host_maintenance
string
|
success |
Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE.
For more information, see Setting Instance Scheduling Options.
|
||||
|
preemptible
boolean
|
success |
Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.
|
||||
|
service_accounts
complex
|
success |
A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
|
||||
|
email
string
|
success |
Email address of the service account.
|
||||
|
scopes
list
|
success |
The list of scopes to be made available for this service account.
|
||||
|
status
string
|
success |
The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.
|
||||
|
status_message
string
|
success |
An optional, human-readable explanation of the status.
|
||||
|
tags
complex
|
success |
A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
|
||||
|
fingerprint
string
|
success |
Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking.
The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
|
||||
|
items
list
|
success |
An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
|
||||
|
zone
string
|
success |
A reference to the zone where the machine resides.
|
||||
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Google Inc. (@googlecloudplatform)
Hint
If you notice any issues in this documentation you can edit this document to improve it.