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_network.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| auth_kind string / required |
| The type of credential used. | |
| auto_create_subnetworks boolean |
| When set to `true`, the network is created in "auto subnet mode" and it will create a subnet for each region automatically across the `10.128.0.0/9` address range. When set to `false`, the network is created in "custom subnet mode" so the user can explicitly connect subnetwork resources. | |
| description string | An optional description of this resource. The resource must be recreated to modify this field. | ||
| 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. | ||
| mtu integer | Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1500 bytes. | ||
| 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. | ||
| project string | The Google Cloud Platform project to use. | ||
| routing_config dictionary | The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. | ||
| routing_mode string / required | The network-wide routing mode to use. If set to `REGIONAL`, this network's cloud routers will only advertise routes with subnetworks of this network in the same region as the router. If set to `GLOBAL`, this network's cloud routers will advertise routes with all subnetworks of this network, across regions. Some valid choices include: "REGIONAL", "GLOBAL" | ||
| 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 | |
Note
gcp_service_account_file env variable.GCP_SERVICE_ACCOUNT_CONTENTS env variable.GCP_SERVICE_ACCOUNT_EMAIL env variable.GCP_AUTH_KIND env variable.GCP_SCOPES env variable.- name: create a network
google.cloud.gcp_compute_network:
name: test_object
auto_create_subnetworks: 'true'
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
| autoCreateSubnetworks boolean | success | When set to `true`, the network is created in "auto subnet mode" and it will create a subnet for each region automatically across the `10.128.0.0/9` address range. When set to `false`, the network is created in "custom subnet mode" so the user can explicitly connect subnetwork resources. | |
| creationTimestamp string | success | Creation timestamp in RFC3339 text format. | |
| description string | success | An optional description of this resource. The resource must be recreated to modify this field. | |
| gateway_ipv4 string | success | The gateway address for default routing out of the network. This value is selected by GCP. | |
| id integer | success | The unique identifier for the resource. | |
| mtu integer | success | Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1500 bytes. | |
| 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. | |
| routingConfig complex | success | The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. | |
| routingMode string | success | The network-wide routing mode to use. If set to `REGIONAL`, this network's cloud routers will only advertise routes with subnetworks of this network in the same region as the router. If set to `GLOBAL`, this network's cloud routers will advertise routes with all subnetworks of this network, across regions. | |
| subnetworks list / elements=string | success | Server-defined fully-qualified URLs for all subnetworks in this network. | |
© 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_network_module.html