gcp_target_proxy - Create, Update or Destroy a Target_Proxy.
New in version 2.4.
Synopsis
- Create, Update or Destroy a Target_Proxy. See https://cloud.google.com/compute/docs/load-balancing/http/target-proxies for an overview. More details on the Target_Proxy API can be found at https://cloud.google.com/compute/docs/reference/latest/targetHttpProxies#resource-representations.
Requirements (on host that executes module)
- python >= 2.6
- google-api-python-client >= 1.6.2
- google-auth >= 0.9.0
- google-auth-httplib2 >= 0.0.2
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
target_proxy_name | yes | Name of the Target_Proxy. | ||
target_proxy_type | yes | Type of Target_Proxy. HTTP, HTTPS or SSL. Only HTTP is currently supported. | ||
url_map_name | no | Name of the Url Map. Required if type is HTTP or HTTPS 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 Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
state | state of the Target_Proxy | Always. | str | present |
target_proxy | GCP Target_Proxy dictionary | Always. Refer to GCP documentation for detailed field descriptions. | dict | {'urlMap': '...', 'name': 'my-target-proxy'} |
target_proxy_name | Name of the Target_Proxy | Always | str | my-target-proxy |
target_proxy_type | Type of Target_Proxy. One of HTTP, HTTPS or SSL. | Always | str | HTTP |
updated_target_proxy | True if the target_proxy has been updated. Will not appear on initial target_proxy creation. | if the target_proxy has been updated. | bool | True |
Notes
Note
- Currently only supports global HTTP proxy.
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/gcp_target_proxy_module.html