upsertSecret

The upsertSecret operation handles configuration related to Secret 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.
name	True	string	A mandatory alphanumeric string containing a unique name for the object, from 1 to 128 characters without spaces. The string may contain the characters + and - but it must start with an alphanumeric character. Names are case-insensitive and duplicate names are not allowed.
description	False	string	An optional unicode alphanumeric string containing a description of the object, up to 200 characters. The string cannot include HTML tags Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist)
password	True	string	A string containing one or more characters. It cannot be all spaces. Passwords must adhere to the requirements of the ASA commands where this secret would be used. Field level constraints: cannot be null. (Note: Additional constraints might exist)
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	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 'upsertSecret' operation
  ftd_configuration:
    operation: "upsertSecret"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        password: "{{ password }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"