addSecret
The addSecret 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 | |||
---|---|---|---|---|---|---|
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) |
|||
type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. |
Example
- name: Execute 'addSecret' operation
ftd_configuration:
operation: "addSecret"
data:
name: "{{ name }}"
description: "{{ description }}"
password: "{{ password }}"
type: "{{ type }}"