delowan / delowan.googlecloud / 1.0.2 / module / gcp_compute_network_endpoint_group Creates a GCP NetworkEndpointGroup Authors: Google Inc. (@googlecloudplatform) preview | supported by communitydelowan.googlecloud.gcp_compute_network_endpoint_group (1.0.2) — module
Install with ansible-galaxy collection install delowan.googlecloud:==1.0.2
collections: - name: delowan.googlecloud version: 1.0.2
Network endpoint groups (NEGs) are zonal resources that represent collections of IP address and port combinations for GCP resources within a single subnet. Each IP address and port combination is called a network endpoint.
Network endpoint groups can be used as backends in backend services for HTTP(S), TCP proxy, and SSL proxy load balancers. You cannot use NEGs as a backend with internal load balancers. Because NEG backends allow you to specify IP addresses and ports, you can distribute traffic in a granular fashion among applications or containers running within VM instances.
Recreating a network endpoint group that's in use by another resource will give a `resourceInUseByAnotherResource` error. Use `lifecycle.create_before_destroy` to avoid this type of error.
- name: create a network google.cloud.gcp_compute_network: name: "{{ resource_name }}" auto_create_subnetworks: 'false' project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: network
- name: create a subnetwork google.cloud.gcp_compute_subnetwork: name: "{{ resource_name }}" ip_cidr_range: 10.0.0.0/16 region: us-central1 network: "{{ network }}" project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: subnetwork
- name: create a network endpoint group google.cloud.gcp_compute_network_endpoint_group: name: test_object network: "{{ network }}" subnetwork: "{{ subnetwork }}" default_port: 90 zone: us-central1-a project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present
name: description: - 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. required: true type: str zone: description: - Zone where the network endpoint group is located. required: true type: str state: choices: - present - absent default: present description: - Whether the given object should exist in GCP type: str scopes: description: - Array of scopes to be used elements: str type: list network: description: - The network to which all network endpoints in the NEG belong. - Uses "default" project network if unspecified. - '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 "{{ name-of-resource }}"' required: true type: dict project: description: - The Google Cloud Platform project to use. type: str env_type: description: - 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. type: str auth_kind: choices: - application - machineaccount - serviceaccount description: - The type of credential used. required: true type: str subnetwork: description: - Optional subnetwork to which all network endpoints in the NEG belong. - 'This field represents a link to a Subnetwork 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_subnetwork task and then set this subnetwork field to "{{ name-of-resource }}"' required: false type: dict description: description: - An optional description of this resource. Provide this property when you create the resource. required: false type: str default_port: description: - The default port used if the port number is not specified in the network endpoint. required: false type: int service_account_file: description: - The path of a Service Account JSON file if serviceaccount is selected as type. type: path network_endpoint_type: default: GCE_VM_IP_PORT description: - Type of network endpoints in this network endpoint group. - 'Some valid choices include: "GCE_VM_IP_PORT"' required: false type: str service_account_email: description: - An optional service account email address if machineaccount is selected and the user does not wish to use the default email. type: str service_account_contents: description: - The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. type: jsonarg
defaultPort: description: - The default port used if the port number is not specified in the network endpoint. returned: success type: int description: description: - An optional description of this resource. Provide this property when you create the resource. returned: success type: str id: description: - The unique identifier for the resource. returned: success type: int name: description: - 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. returned: success type: str network: description: - The network to which all network endpoints in the NEG belong. - Uses "default" project network if unspecified. returned: success type: dict networkEndpointType: description: - Type of network endpoints in this network endpoint group. returned: success type: str size: description: - Number of network endpoints in the network endpoint group. returned: success type: int subnetwork: description: - Optional subnetwork to which all network endpoints in the NEG belong. returned: success type: dict zone: description: - Zone where the network endpoint group is located. returned: success type: str