upsertHTTPProxy

The upsertHTTPProxy operation handles configuration related to HTTPProxy model.

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter	Required	Type	Description
version	False	string	A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
enabled	False	boolean	A Boolean value, TRUE or FALSE. TRUE indicates that the server is enabled. It will be used for management connections. Specify FALSE to disable the proxy server without deleting it.
authenticate	False	boolean	A Boolean value, TRUE or FALSE. TRUE indicates that the target server requires authentication. The default is {FALSE \| TRUE}.
proxyServer	False	string	A String value. Management IP address for the HTTP Proxy Server. Field level constraints: must be a valid IP address. (Note: Additional constraints might exist)
port	False	integer	An integer, 1 - 65535, that is the HTTP. port number for the proxy server from the user input. Field level constraints: must be between 0 and 65535 (inclusive). (Note: Additional constraints might exist)
username	False	string	(Required if authentication is TRUE). The username for logging into the proxy server. Field level constraints: must match pattern ^((?!;).)*$, length must be between 0 and 256 (inclusive). (Note: Additional constraints might exist)
password	False	string	(Required if authentication = TRUE.) A string that is the password for the username for authenticated access to the proxy server. The password must be 8-16 characters.
id	False	string	A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Query Parameters

Parameter	Required	Type	Description
filter	True	string	The criteria used to filter the models you are requesting. It should have the following format: {key}{operator}{value}[;{key}{operator}{value}]. Supported operators are: "!"(not equals), ":"(equals), "~"(similar). Supported keys are: "name".

Example

- name: Execute 'upsertHTTPProxy' operation
  ftd_configuration:
    operation: "upsertHTTPProxy"
    data:
        version: "{{ version }}"
        enabled: "{{ enabled }}"
        authenticate: "{{ authenticate }}"
        proxyServer: "{{ proxy_server }}"
        port: "{{ port }}"
        username: "{{ username }}"
        password: "{{ password }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"