On this page
google.cloud.gcp_compute_instance_group_manager – Creates a GCP InstanceGroupManager
Note
This plugin is part of the google.cloud collection (version 1.0.2).
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.
To use it in a playbook, specify: google.cloud.gcp_compute_instance_group_manager.
Synopsis
- Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances.
 - A managed instance group can have up to 1000 VM instances per group.
 
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.
         | 
     |
| base_instance_name
        
        string / required
         | 
      
        
        The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name.
        
       
        The base instance name must comply with RFC1035.
         | 
     ||
| description
        
        string
         | 
      
        
        An optional description of this resource. Provide this property when you create the 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_template
        
        dictionary / required
         | 
      
        
        The instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
        
       
        This field represents a link to a InstanceTemplate 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_template task and then set this instance_template field to "{{ name-of-resource }}"
         | 
     ||
| name
        
        string / required
         | 
      
        
        The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
         | 
     ||
| named_ports
        
        list / elements=dictionary
         | 
      
        
        Named ports configured for the Instance Groups complementary to this Instance Group Manager.
         | 
     ||
| name
        
        string
         | 
      
        
        The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
         | 
     ||
| port
        
        integer
         | 
      
        
        The port number, which can be a value between 1 and 65535.
         | 
     ||
| 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
         | 
     |
| target_pools
        
        list / elements=dictionary
         | 
      
        
        TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
         | 
     ||
| target_size
        
        integer
         | 
      
        
        The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
         | 
     ||
| zone
        
        string / required
         | 
      
        
        The zone the managed instance group resides.
         | 
     ||
Examples
- name: create a network
  google.cloud.gcp_compute_network:
    name: network-instancetemplate
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network
- name: create a address
  google.cloud.gcp_compute_address:
    name: address-instancetemplate
    region: us-west1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: address
- name: create a instance template
  google.cloud.gcp_compute_instance_template:
    name: "{{ resource_name }}"
    properties:
      disks:
      - auto_delete: 'true'
        boot: 'true'
        initialize_params:
          source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts
      machine_type: n1-standard-1
      network_interfaces:
      - network: "{{ network }}"
        access_configs:
        - name: test-config
          type: ONE_TO_ONE_NAT
          nat_ip: "{{ address }}"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instancetemplate
- name: create a instance group manager
  google.cloud.gcp_compute_instance_group_manager:
    name: test_object
    base_instance_name: test1-child
    instance_template: "{{ instancetemplate }}"
    target_size: 3
    zone: us-west1-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 | |
|---|---|---|---|
| baseInstanceName
        
        string
         | 
      success | 
        
        The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name.
        
       
        The base instance name must comply with RFC1035.
          | 
     |
| creationTimestamp
        
        string
         | 
      success | 
        
        The creation timestamp for this managed instance group in RFC3339 text format.
          | 
     |
| currentActions
        
        complex
         | 
      success | 
        
        The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
          | 
     |
| abandoning
        
        integer
         | 
      success | 
        
        The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
          | 
     |
| creating
        
        integer
         | 
      success | 
        
        The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
        
       
        If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
          | 
     |
| creatingWithoutRetries
        
        integer
         | 
      success | 
        
        The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
          | 
     |
| deleting
        
        integer
         | 
      success | 
        
        The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
          | 
     |
| none
        
        integer
         | 
      success | 
        
        The number of instances in the managed instance group that are running and have no scheduled actions.
          | 
     |
| recreating
        
        integer
         | 
      success | 
        
        The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated.
        
       
        Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
          | 
     |
| refreshing
        
        integer
         | 
      success | 
        
        The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
          | 
     |
| restarting
        
        integer
         | 
      success | 
        
        The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
          | 
     |
| description
        
        string
         | 
      success | 
        
        An optional description of this resource. Provide this property when you create the resource.
          | 
     |
| id
        
        integer
         | 
      success | 
        
        A unique identifier for this resource.
          | 
     |
| instanceGroup
        
        dictionary
         | 
      success | 
        
        The instance group being managed.
          | 
     |
| instanceTemplate
        
        dictionary
         | 
      success | 
        
        The instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
          | 
     |
| name
        
        string
         | 
      success | 
        
        The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
          | 
     |
| namedPorts
        
        complex
         | 
      success | 
        
        Named ports configured for the Instance Groups complementary to this Instance Group Manager.
          | 
     |
| name
        
        string
         | 
      success | 
        
        The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
          | 
     |
| port
        
        integer
         | 
      success | 
        
        The port number, which can be a value between 1 and 65535.
          | 
     |
| region
        
        string
         | 
      success | 
        
        The region this managed instance group resides (for regional resources).
          | 
     |
| targetPools
        
        list / elements=string
         | 
      success | 
        
        TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
          | 
     |
| targetSize
        
        integer
         | 
      success | 
        
        The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
          | 
     |
| zone
        
        string
         | 
      success | 
        
        The zone the managed instance group 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/latest/collections/google/cloud/gcp_compute_instance_group_manager_module.html