upsertRaVpn
The upsertRaVpn operation handles configuration related to RaVpn 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 | version of RaVpn | |||
| name | True | string | name of RAVpn | |||
| externalBrowserPackage | False | object | The external browser package that is assigned for SAML server authentication. Although defined in the RA VPN connection profile, this attribute is global to all connection profiles: you cannot set different packages for different profiles. Allowed types are: [ExternalBrowserPackage] |
|||
| vpnGatewaySettings | True | object | Nested entity, will contain the common objects like certificates etc Field level constraints: cannot be null. (Note: Additional constraints might exist) |
|||
| groupPolicies | False | [object] | List of group policies Allowed types are: [RaVpnGroupPolicy] |
|||
| anyconnectPackageFiles | False | [object] | Anyconnect package files, which will be cretaed as part of objects, & will be deployed , when will deploy RAVpn Allowed types are: [AnyConnectPackageFile] |
|||
| dap | False | object | DAP config deployed on device Allowed types are: [DAPXml] |
|||
| id | False | string | id Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
| type | True | string | ravpn | |||
Query Parameters
| Parameter | Required | Type | Description | |||
|---|---|---|---|---|---|---|
| filter | False | 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", "fts". The "fts" filter cannot be used with other filters. Default filtering for Upsert operation is done by name. | |||
Example
- name: Execute 'upsertRaVpn' operation
ftd_configuration:
operation: "upsertRaVpn"
data:
version: "{{ version }}"
name: "{{ name }}"
externalBrowserPackage: "{{ external_browser_package }}"
vpnGatewaySettings: "{{ vpn_gateway_settings }}"
groupPolicies: "{{ group_policies }}"
anyconnectPackageFiles: "{{ anyconnect_package_files }}"
dap: "{{ dap }}"
id: "{{ id }}"
type: "{{ type }}"
query_params:
filter: "{{ filter }}"