addGeoLocation
The addGeoLocation operation handles configuration related to GeoLocation model.
Description
This API call is not allowed on the standby unit in an HA pair.
Data Parameters
Parameter | Required | Type | Description | |||
---|---|---|---|---|---|---|
name | True | string | A String object containing the name of the Geolocation object. The string can be a maximum of 128 characters. | |||
description | False | string | A String object which describes the Geolocation object. The string can be a maximum of 200 characters. Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist) |
|||
locations | False | [object] | A Set of CountryBase objects which contain information about the Countries/Continents Allowed types are: [Continent, Country] |
|||
type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. |
Example
- name: Execute 'addGeoLocation' operation
ftd_configuration:
operation: "addGeoLocation"
data:
name: "{{ name }}"
description: "{{ description }}"
locations: "{{ locations }}"
type: "{{ type }}"