gcp_compute_subnetwork – Creates a GCP Subnetwork

gcp_compute_subnetwork – Creates a GCP Subnetwork

New in version 2.6.

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• A VPC network is a virtual version of the traditional physical networks that exist within and between physical data centers. A VPC network provides connectivity for your Compute Engine virtual machine (VM) instances, Container Engine containers, App Engine Flex services, and other network-related resources.
• Each GCP project contains one or more VPC networks. Each VPC network is a global entity spanning all GCP regions. This global VPC network allows VM instances and other resources to communicate with each other via internal, private IP addresses.
• Each VPC network is subdivided into subnets, and each subnet is contained within a single region. You can have more than one subnet in a region for a given VPC network. Each subnet has a contiguous private RFC1918 IP space. You create instances, containers, and the like in these subnets.
• When you create an instance, you must create it in a subnet, and the instance draws its internal IP address from that subnet.
• Virtual machine (VM) instances in a VPC network can communicate with instances in all other subnets of the same VPC network, regardless of region, using their RFC1918 private IP addresses. You can isolate portions of the network, even entire subnets, using firewall 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		application machineaccount serviceaccount	The type of credential used.
description -			An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.
enable_flow_logs boolean added in 2.8		no yes	Whether to enable flow logging for this subnetwork.
ip_cidr_range - / required			The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported.
name - / required			The name of the resource, provided by the client when initially creating the resource. 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.
network - / required			The network this subnet belongs to. Only networks that are in the distributed mode can have subnetworks. This field represents a link to a Network 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_network task and then set this network field to "Template:Name-of-resource"
private_ip_google_access boolean		no yes	When enabled, VMs in this subnetwork without external IP addresses can access Google APIs and services by using Private Google Access.
project string			The Google Cloud Platform project to use.
region - / required			URL of the GCP region for this subnetwork.
scopes list			Array of scopes to be used.
secondary_ip_ranges - added in 2.8			An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges.
	ip_cidr_range - / required		The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported.
	range_name - / required		The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.
service_account_contents string			A string representing the contents of a Service Account JSON file. This should not be passed in as a dictionary, but a string that has the exact contents of a service account json file (valid JSON)
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 -		present ← absent	Whether the given object should exist in GCP

Notes

Note

• API Reference: https://cloud.google.com/compute/docs/reference/rest/beta/subnetworks
• Private Google Access: https://cloud.google.com/vpc/docs/configure-private-google-access
• Cloud Networking: https://cloud.google.com/vpc/docs/using-vpc
• For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE env variable.
• For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
• For authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.
• For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.
• For authentication, you can set scopes using the GCP_SCOPES env 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
  gcp_compute_network:
    name: network-subnetwork
    auto_create_subnetworks: 'true'
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network

- name: create a subnetwork
  gcp_compute_subnetwork:
    name: ansiblenet
    region: us-west1
    network: "{{ network }}"
    ip_cidr_range: 172.16.0.0/16
    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. Provide this property when you create the resource. This field can be set only at resource creation time.
enableFlowLogs boolean		success	Whether to enable flow logging for this subnetwork.
fingerprint string		success	Fingerprint of this resource. This field is used internally during updates of this resource.
gatewayAddress string		success	The gateway address for default routes to reach destination addresses outside this subnetwork.
id integer		success	The unique identifier for the resource.
ipCidrRange string		success	The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported.
name string		success	The name of the resource, provided by the client when initially creating the resource. 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.
network dictionary		success	The network this subnet belongs to. Only networks that are in the distributed mode can have subnetworks.
privateIpGoogleAccess boolean		success	When enabled, VMs in this subnetwork without external IP addresses can access Google APIs and services by using Private Google Access.
region string		success	URL of the GCP region for this subnetwork.
secondaryIpRanges complex		success	An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges.
	ipCidrRange string	success	The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported.
	rangeName string	success	The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.

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.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gcp_compute_subnetwork_module.html