upsertRealmSequence

The upsertRealmSequence operation handles configuration related to RealmSequence 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	A UTF string containing the name for the Realm Sequence.
description	False	string	Description of this RealmSequence object. The string can be up to 200 characters. Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
realms	True	[object]	A list of Identity Realms Field level constraints: cannot be blank or empty. (Note: Additional constraints might exist) Allowed types are: [ActiveDirectoryRealm]
id	False	string	UUID Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type	True	string	RealmSequence 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 'upsertRealmSequence' operation
  ftd_configuration:
    operation: "upsertRealmSequence"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        realms: "{{ realms }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"