upsertSGTDynamicObject

The upsertSGTDynamicObject operation handles configuration related to SGTDynamicObject 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	Current version of the object
name	False	string	User defined string name of the object
description	False	string	User defined description for the object Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
tags	True	[object]	List of SecurityGroupTagEntry tag references Field level constraints: cannot be null. (Note: Additional constraints might exist)
id	False	string	UUID Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type	True	string	SGTDynamicObject object type

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 'upsertSGTDynamicObject' operation
  ftd_configuration:
    operation: "upsertSGTDynamicObject"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        tags: "{{ tags }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"