Documentation

gcp_target_proxy - Create, Update or Destroy a Target_Proxy.

New in version 2.4.

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • google-api-python-client >= 1.6.2
  • google-auth >= 0.9.0
  • google-auth-httplib2 >= 0.0.2

Parameters

Parameter Choices/Defaults Comments
target_proxy_name
required
Name of the Target_Proxy.
target_proxy_type
required
Type of Target_Proxy. HTTP, HTTPS or SSL. Only HTTP is currently supported.
url_map_name
Name of the Url Map. Required if type is HTTP or HTTPS proxy.

Notes

Note

  • Currently only supports global HTTP proxy.

Examples

- name: Create Minimum HTTP Target_Proxy
  gcp_target_proxy:
    service_account_email: "{{ service_account_email }}"
    credentials_file: "{{ credentials_file }}"
    project_id: "{{ project_id }}"
    target_proxy_name: my-target_proxy
    target_proxy_type: HTTP
    url_map_name: my-url-map
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
state
str
Always.
state of the Target_Proxy

Sample:
present
target_proxy
dict
Always. Refer to GCP documentation for detailed field descriptions.
GCP Target_Proxy dictionary

Sample:
{'urlMap': '...', 'name': 'my-target-proxy'}
target_proxy_name
str
Always
Name of the Target_Proxy

Sample:
my-target-proxy
target_proxy_type
str
Always
Type of Target_Proxy. One of HTTP, HTTPS or SSL.

Sample:
HTTP
updated_target_proxy
bool
if the target_proxy has been updated.
True if the target_proxy has been updated. Will not appear on initial target_proxy creation.

Sample:
True


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

Hint

If you notice any issues in this documentation you can edit this document to improve it.