Description

The addSNMPUserGroup operation handles configuration related to SNMPUserGroup model. 
This API call is not allowed on the standby unit in an HA pair.

HTTP request

POST /api/fdm/v6/object/snmpusergroups

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

curl -X POST \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "description": "string",
        "id": "string",
        "name": "string",
        "type": "snmpusergroup",
        "users": [
            {
                "id": "string",
                "name": "string",
                "type": "string",
                "version": "string"
            }
        ],
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/object/snmpusergroups"
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient


def get_client(host, token):
    http_client = RequestsClient()
    http_client.ssl_verify = False
    http_client.set_api_key(
        host,
        "Bearer {}".format(token),
        param_name="Authorization",
        param_in="header"
    )
    return SwaggerClient.from_url(
        "https://{}/apispec/ngfw.json".format(host),
        http_client=http_client,
        config={
            "validate_responses": False,
            "validate_swagger_spec": False
        }
    )


def add_snmp_user_group(client, body):
    return client.SNMP.addSNMPUserGroup(
        body=body
    ).response().result


if __name__ == "__main__":
    host = "ftd.example.com"
    token = "access_token"
    client = get_client(host, token)

    body = {'description': 'string',
 'name': 'string',
 'type': 'snmpusergroup',
 'users': [{'id': 'string',
            'name': 'string',
            'type': 'string',
            'version': 'string'}]}

    add_snmp_user_group(client, body)