addSNMPUserGroup

The addSNMPUserGroup operation handles configuration related to SNMPUserGroup model. 

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter Required Type Description
name False string Specifies the Name of the user list, which may be up to 33 characters long
description False string Description of SNMP user group object.
Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
users True [object] SNMPv3 user. Multiple such users can be associated with a single user-list.
Field level constraints: cannot be blank or empty. (Note: Additional constraints might exist)
Allowed types are: [SNMPUser]
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Example

- name: Execute 'addSNMPUserGroup' operation
  ftd_configuration:
    operation: "addSNMPUserGroup"
    data:
        name: "{{ name }}"
        description: "{{ description }}"
        users: "{{ users }}"
        type: "{{ type }}"