google.cloud.gcp_compute_target_instance – Creates a GCP TargetInstance
Note
This plugin is part of the google.cloud collection (version 1.0.2).
To install it use: ansible-galaxy collection install google.cloud.
To use it in a playbook, specify: google.cloud.gcp_compute_target_instance.
Synopsis
- Represents a TargetInstance resource which defines an endpoint instance that terminates traffic of certain protocols. In particular, they are used in Protocol Forwarding, where forwarding rules can send packets to a non-NAT’ed target instance. Each target instance contains a single virtual machine instance that receives and handles traffic from the corresponding forwarding rules.
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  string / required  | 
 | The type of credential used. | 
| description  string  | An optional description of this resource. | |
| 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. | |
| instance  dictionary / required  | A URL to the virtual machine instance that handles traffic for this target instance. Accepts self-links or the partial paths with format `projects/project/zones/zone/instances/instance' or `zones/zone/instances/instance` . This field represents a link to a Instance resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_instance task and then set this instance field to "{{ name-of-resource }}" | |
| name  string / required  | 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]*[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. | |
| nat_policy  string  | Default: "NO_NAT" | NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. Some valid choices include: "NO_NAT" | 
| 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. | |
| state  string  | 
 | Whether the given object should exist in GCP | 
| zone  string / required  | URL of the zone where the target instance resides. | 
Notes
Note
- API Reference: https://cloud.google.com/compute/docs/reference/v1/targetInstances
- Using Protocol Forwarding: https://cloud.google.com/compute/docs/protocol-forwarding
- for authentication, you can set service_account_file using the gcp_service_account_fileenv variable.
- for authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTSenv 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: create a network
  google.cloud.gcp_compute_network:
    name: network-instance
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network
- name: create a instance
  google.cloud.gcp_compute_instance:
    name: "{{ resource_name }}"
    machine_type: n1-standard-1
    disks:
    - auto_delete: 'true'
      boot: 'true'
      initialize_params:
        source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts
    labels:
      environment: production
    network_interfaces:
    - network: "{{ network }}"
    zone: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instance
- name: create a target instance
  google.cloud.gcp_compute_target_instance:
    name: target
    instance: "{{ instance }}"
    zone: us-central1-a
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present
   Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
| creationTimestamp  string  | success | Creation timestamp in RFC3339 text format. | 
| description  string  | success | An optional description of this resource. | 
| instance  dictionary  | success | A URL to the virtual machine instance that handles traffic for this target instance. Accepts self-links or the partial paths with format `projects/project/zones/zone/instances/instance' or `zones/zone/instances/instance` . | 
| name  string  | success | 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]*[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. | 
| natPolicy  string  | success | NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. | 
| zone  string  | success | URL of the zone where the target instance resides. | 
Authors
- Google Inc. (@googlecloudplatform)
    © 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_target_instance_module.html